gem-graph/gem-graph-client
gem-graph
/
gem-graph-client
3
0
Fork 0
Code Issues 14 Pull Requests Projects Releases Activity

doxygen: all functions documented

This commit is contained in:
Jean Sirmai 2024-10-25 17:32:30 +02:00
parent 16e777ed1a
commit 6f34c0ceaf
Signed by: jean
GPG Key ID: FB3115C340E057E3
114 changed files with 2634 additions and 786 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/docbook/annotated.xml
View File

@ -23,9 +23,7 @@ Here are the classes, structs, unions and interfaces with brief descriptions:<li
<para>Phantom documentation </para>
<link linkend="_structpreferences">preferences</link><link linkend="_structslist">slist</link>
<para>Phantom documentation </para>
<link linkend="_structStack">Stack</link>
<para>Phantom documentation </para>
<link linkend="_structstack__index__t">stack_index_t</link>
<link linkend="_structStack">Stack</link><link linkend="_structstack__index__t">stack_index_t</link>
<para>Phantom documentation </para>
<link linkend="_structTreeNode__t">TreeNode_t</link>
<para>Phantom documentation used to test the functioning of doxygen </para>

19
doc/docbook/d0/d00/middle_8c.xml
View File

@ -10,9 +10,7 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../include/signal.h&quot;<?linebreak?>#include &quot;../../../../include/util.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_middle_8c_1a8019caa45a82a3d92061d49818d0f617"/>void <emphasis role="strong">widget_reset_XYZ_in_state_pane</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void <link linkend="_middle_8c_1a8019caa45a82a3d92061d49818d0f617">widget_reset_XYZ_in_state_pane</link> ()</para>
</listitem>
<listitem><para>void * <link linkend="_middle_8c_1ab37220d257ccf0ac8a2f4b0f41b83ab9">widget_get_space_view</link> (int partition_space_vs_camera)</para>
</listitem>
@ -41,16 +39,25 @@ Parameters</title>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>partition_space_vs_camera</entry><entry>
<para></para>
</entry>
<entry>partition_space_vs_camera</entry><entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>GTK_WIDGET (view_space_vs_camera) </para>
</formalpara>
</para>
</section>
<anchor xml:id="_middle_8c_1a8019caa45a82a3d92061d49818d0f617"/><section>
<title>widget_reset_XYZ_in_state_pane()</title>
<indexterm><primary>widget_reset_XYZ_in_state_pane</primary><secondary>middle.c</secondary></indexterm>
<indexterm><primary>middle.c</primary><secondary>widget_reset_XYZ_in_state_pane</secondary></indexterm>
<para><computeroutput>void widget_reset_XYZ_in_state_pane ( )</computeroutput></para>
<para>phantom documentation </para>
</section>
</section>
</section>

18
doc/docbook/d1/d00/camera_8c.xml
View File

@ -10,9 +10,7 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../../include/signal.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_camera_8c_1a1b97f8be0394a44033a491d7bb44dce2"/>void * <emphasis role="strong">widget_get_selected_rule_camera</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_camera_8c_1a1b97f8be0394a44033a491d7bb44dce2">widget_get_selected_rule_camera</link> ()</para>
</listitem>
</itemizedlist>
</simplesect>
@ -23,4 +21,18 @@
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_camera_8c_1a1b97f8be0394a44033a491d7bb44dce2"/><section>
<title>widget_get_selected_rule_camera()</title>
<indexterm><primary>widget_get_selected_rule_camera</primary><secondary>camera.c</secondary></indexterm>
<indexterm><primary>camera.c</primary><secondary>widget_get_selected_rule_camera</secondary></indexterm>
<para><computeroutput>void * widget_get_selected_rule_camera ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>camera </para>
</formalpara>
</para>
</section>
</section>
</section>

18
doc/docbook/d1/d04/investigate_8c.xml
View File

@ -10,9 +10,7 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../../include/signal.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_investigate_8c_1a4d4d650591869cebc663884c29c6bb7c"/>void * <emphasis role="strong">widget_get_rule_investigation_tools</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_investigate_8c_1a4d4d650591869cebc663884c29c6bb7c">widget_get_rule_investigation_tools</link> ()</para>
</listitem>
</itemizedlist>
</simplesect>
@ -23,4 +21,18 @@
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_investigate_8c_1a4d4d650591869cebc663884c29c6bb7c"/><section>
<title>widget_get_rule_investigation_tools()</title>
<indexterm><primary>widget_get_rule_investigation_tools</primary><secondary>investigate.c</secondary></indexterm>
<indexterm><primary>investigate.c</primary><secondary>widget_get_rule_investigation_tools</secondary></indexterm>
<para><computeroutput>void * widget_get_rule_investigation_tools ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>gtk_label_new (&quot;RULE INVESTIGATION&quot;) </para>
</formalpara>
</para>
</section>
</section>
</section>

39
doc/docbook/d1/d0b/widget_2main__window_2one__rule_2dispatch_8c.xml
View File

@ -10,13 +10,9 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../include/signal.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_widget_2main__window_2one__rule_2dispatch_8c_1ab6a3b9836a4c333b59b34cb97d00df3a"/>void * <emphasis role="strong">widget_get_selected_rule</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2one__rule_2dispatch_8c_1ab6a3b9836a4c333b59b34cb97d00df3a">widget_get_selected_rule</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_2main__window_2one__rule_2dispatch_8c_1ab9db55b708939397362a8a11489c64c5"/>void * <emphasis role="strong">widget_get_pane_selected_rule_right</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2one__rule_2dispatch_8c_1ab9db55b708939397362a8a11489c64c5">widget_get_pane_selected_rule_right</link> ()</para>
</listitem>
</itemizedlist>
</simplesect>
@ -27,4 +23,35 @@
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_widget_2main__window_2one__rule_2dispatch_8c_1ab9db55b708939397362a8a11489c64c5"/><section>
<title>widget_get_pane_selected_rule_right()</title>
<indexterm><primary>widget_get_pane_selected_rule_right</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_get_pane_selected_rule_right</secondary></indexterm>
<para><computeroutput>void * widget_get_pane_selected_rule_right ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>GTK_WIDGET (rule_itself_vs_explore_edit_pane) </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2main__window_2one__rule_2dispatch_8c_1ab6a3b9836a4c333b59b34cb97d00df3a"/><section>
<title>widget_get_selected_rule()</title>
<indexterm><primary>widget_get_selected_rule</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_get_selected_rule</secondary></indexterm>
<para><computeroutput>void * widget_get_selected_rule ( )</computeroutput></para>
<para>start_child in GtkPaned rule_itself_vs_explore_edit_pane</para>
<para><formalpara><title>See also</title>
<para>src/widget/main_window/one_rule/algebra/dispatch/widget_get_selected_rule_algebra() </para>
<para>src/widget/main_window/one_rule/geometry/dispatch/widget_get_selected_rule_geometry()</para>
<para>src/widget/main_window/one_rule/dispatch/widget_get_pane_selected_rule_right() </para>
</formalpara>
</para>
</section>
</section>
</section>

24
doc/docbook/d3/d09/widget_2manager_8c.xml
View File

@ -11,16 +11,10 @@
<title>Functions </title>
<itemizedlist>
<listitem><para>GtkWindow * <link linkend="_widget_2manager_8c_1aa79c2ff4883932d6f9b7184d1d05dd5d">widget_get_main_window</link> ()</para>
<para>getter </para>
</listitem>
<listitem><para>GtkWindow * <link linkend="_widget_2manager_8c_1a8a3fc181cce5aa9cfb0623abf0315f5d">widget_get_dialog_window</link> ()</para>
<para>getter </para>
</listitem>
<listitem><para>GtkWindow * <link linkend="_widget_2manager_8c_1a84dce957680294b8b928c5bc9b2c1dfb">widget_get_text_window</link> ()</para>
<para>getter </para>
</listitem>
<listitem><para>void <link linkend="_widget_2manager_8c_1a9fa76559222320b25d10f05eeb9b5869">on_windows_startup</link> (GtkApplication *app)</para>
</listitem>
@ -121,11 +115,7 @@ Parameters</title>
<title>widget_get_dialog_window()</title>
<indexterm><primary>widget_get_dialog_window</primary><secondary>manager.c</secondary></indexterm>
<indexterm><primary>manager.c</primary><secondary>widget_get_dialog_window</secondary></indexterm>
<para><computeroutput>GtkWindow * widget_get_dialog_window ( )</computeroutput></para><para>
<para>getter </para>
</para>
<para><computeroutput>GtkWindow * widget_get_dialog_window ( )</computeroutput></para>
<para><formalpara><title>Since</title>
<para>2024-07</para>
@ -144,11 +134,7 @@ Parameters</title>
<title>widget_get_main_window()</title>
<indexterm><primary>widget_get_main_window</primary><secondary>manager.c</secondary></indexterm>
<indexterm><primary>manager.c</primary><secondary>widget_get_main_window</secondary></indexterm>
<para><computeroutput>GtkWindow * widget_get_main_window ( )</computeroutput></para><para>
<para>getter </para>
</para>
<para><computeroutput>GtkWindow * widget_get_main_window ( )</computeroutput></para>
<para><formalpara><title>Since</title>
<para>2024-07</para>
@ -167,11 +153,7 @@ Parameters</title>
<title>widget_get_text_window()</title>
<indexterm><primary>widget_get_text_window</primary><secondary>manager.c</secondary></indexterm>
<indexterm><primary>manager.c</primary><secondary>widget_get_text_window</secondary></indexterm>
<para><computeroutput>GtkWindow * widget_get_text_window ( )</computeroutput></para><para>
<para>getter </para>
</para>
<para><computeroutput>GtkWindow * widget_get_text_window ( )</computeroutput></para>
<para><formalpara><title>Since</title>
<para>2024-07</para>

18
doc/docbook/d3/d0c/widget_2main__window_2all__rules_2dispatch_8c.xml
View File

@ -10,9 +10,7 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../include/signal.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_widget_2main__window_2all__rules_2dispatch_8c_1a1c074a5748ee5c7e9974bb75539adb34"/>void * <emphasis role="strong">widget_get_pane_all_rules_left</emphasis> ()</para>
<para>phantom documentation </para>
<listitem><para>void * <link linkend="_widget_2main__window_2all__rules_2dispatch_8c_1a1c074a5748ee5c7e9974bb75539adb34">widget_get_pane_all_rules_left</link> ()</para>
</listitem>
</itemizedlist>
</simplesect>
@ -23,4 +21,18 @@
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_widget_2main__window_2all__rules_2dispatch_8c_1a1c074a5748ee5c7e9974bb75539adb34"/><section>
<title>widget_get_pane_all_rules_left()</title>
<indexterm><primary>widget_get_pane_all_rules_left</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_get_pane_all_rules_left</secondary></indexterm>
<para><computeroutput>void * widget_get_pane_all_rules_left ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>rules_tree_and_pilot_box </para>
</formalpara>
</para>
</section>
</section>
</section>

10
doc/docbook/d4/d01/identity_8c.xml
View File

@ -11,8 +11,6 @@
<title>Functions </title>
<itemizedlist>
<listitem><para>void * <link linkend="_identity_8c_1afcfab13d3504a69ec5f4ae6ad6974e29">widget_get_selected_rule_identity_btt</link> ()</para>
<para>Hosts a list of character strings that can be combined to provide a &quot;human readable&quot; rule identifier. </para>
</listitem>
</itemizedlist>
</simplesect>
@ -29,12 +27,8 @@
<title>widget_get_selected_rule_identity_btt()</title>
<indexterm><primary>widget_get_selected_rule_identity_btt</primary><secondary>identity.c</secondary></indexterm>
<indexterm><primary>identity.c</primary><secondary>widget_get_selected_rule_identity_btt</secondary></indexterm>
<para><computeroutput>void * widget_get_selected_rule_identity_btt ( )</computeroutput></para><para>
<para>Hosts a list of character strings that can be combined to provide a &quot;human readable&quot; rule identifier. </para>
</para>
<para>This list can also contain non-mandatory elements.</para>
<para><computeroutput>void * widget_get_selected_rule_identity_btt ( )</computeroutput></para>
<para>Hosts a list of character strings that can be combined to provide a &quot;human readable&quot; rule identifier. This list can also contain non-mandatory elements.</para>
<para>Each rule can have a specific &quot;human readable&quot; 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.</para>

18
doc/docbook/d4/d02/edit_8c.xml
View File

@ -10,9 +10,7 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../../include/signal.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_edit_8c_1a8b314bd2dcf59006649ff86ae04e9eaf"/>void * <emphasis role="strong">widget_get_rule_edition_tools</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_edit_8c_1a8b314bd2dcf59006649ff86ae04e9eaf">widget_get_rule_edition_tools</link> ()</para>
</listitem>
</itemizedlist>
</simplesect>
@ -23,4 +21,18 @@
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_edit_8c_1a8b314bd2dcf59006649ff86ae04e9eaf"/><section>
<title>widget_get_rule_edition_tools()</title>
<indexterm><primary>widget_get_rule_edition_tools</primary><secondary>edit.c</secondary></indexterm>
<indexterm><primary>edit.c</primary><secondary>widget_get_rule_edition_tools</secondary></indexterm>
<para><computeroutput>void * widget_get_rule_edition_tools ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>gtk_label_new (&quot;RULE EDITION&quot;) </para>
</formalpara>
</para>
</section>
</section>
</section>

10
doc/docbook/d5/d02/data__list_8c.xml
View File

@ -29,7 +29,15 @@
<para>a list of available measurements, including those currently in use </para>
<para>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. <formalpara><title>See also</title>
<para>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.)</para>
<para><formalpara><title>See also</title>
<para><link xlink:href="http://www.gnuplot.info/">http://www.gnuplot.info/</link> </para>
<para><link xlink:href="https://fr.wikipedia.org/wiki/Gnuplot">https://fr.wikipedia.org/wiki/Gnuplot</link> </para>
<para><link xlink:href="https://fr.wikibooks.org/wiki/Mathc_gnuplot">https://fr.wikibooks.org/wiki/Mathc_gnuplot</link></para>
<para>: fsm/measure/manage.c </para>
</formalpara>

75
doc/docbook/d5/d03/left_8c.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>src/widget/main_window/topbar/left.c</primary></indexterm>
<para>
<para>Topbar left. </para>
<para>Topbar left design. </para>
</para>
<programlisting linenumbering="unnumbered">#include &quot;../../../../include/base.h&quot;<?linebreak?>#include &quot;../../../../include/signal.h&quot;<?linebreak?>#include &quot;../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../include/fsm.h&quot;<?linebreak?></programlisting><simplesect>
@ -20,55 +20,80 @@
<title>Functions </title>
<itemizedlist>
<listitem><para>const char * <link linkend="_left_8c_1a3d0f8c7b9545a6da3464060dad7990db">widget_get_btt_label_synth</link> ()</para>
<para>! WARNING ! THE LABELS OF THE PREVIOUS FOUR BUTTONS MUST ONLY BE DEFINED ONCE IN THE PROGRAMME (HERE), AND ONLY USING THE FOUR FOLLOWING FUNCTIONS: </para>
</listitem>
<listitem><para><anchor xml:id="_left_8c_1a22ed4aed09c29d9f8c72dbe7ced53e2c"/>const char * <emphasis role="strong">widget_get_btt_label_state</emphasis> ()</para>
<para>btt_state </para>
<listitem><para>const char * <link linkend="_left_8c_1a22ed4aed09c29d9f8c72dbe7ced53e2c">widget_get_btt_label_state</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_left_8c_1adea9b5591d51aab274d8c275045d778c"/>const char * <emphasis role="strong">widget_get_btt_label_rules</emphasis> ()</para>
<para>btt_rules </para>
<listitem><para>const char * <link linkend="_left_8c_1adea9b5591d51aab274d8c275045d778c">widget_get_btt_label_rules</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_left_8c_1a136322baea0729a8dfbc5c9b1bc0667e"/>const char * <emphasis role="strong">widget_get_btt_label_data</emphasis> ()</para>
<para>btt_data <?linebreak?> </para>
<listitem><para>const char * <link linkend="_left_8c_1a136322baea0729a8dfbc5c9b1bc0667e">widget_get_btt_label_data</link> ()</para>
</listitem>
<listitem><para>void <link linkend="_left_8c_1a45d8a02844578e1c13d8b86b74e3c8b0">window_design_topbar_left</link> (GtkWidget *header_bar)</para>
<para>The rules page consists of two half-pages in a GtkPaned widget : </para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>Topbar left. </para>
<para>Topbar left design. </para>
<para><warning><title>Warning</title>
<para>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 &apos;get_btt_label_&apos; FUNCTIONS DEFINED IN THIS FILE </para>
</warning>
</para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_left_8c_1a136322baea0729a8dfbc5c9b1bc0667e"/><section>
<title>widget_get_btt_label_data()</title>
<indexterm><primary>widget_get_btt_label_data</primary><secondary>left.c</secondary></indexterm>
<indexterm><primary>left.c</primary><secondary>widget_get_btt_label_data</secondary></indexterm>
<para><computeroutput>const char * widget_get_btt_label_data ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>&quot;data&quot; </para>
</formalpara>
</para>
</section>
<anchor xml:id="_left_8c_1adea9b5591d51aab274d8c275045d778c"/><section>
<title>widget_get_btt_label_rules()</title>
<indexterm><primary>widget_get_btt_label_rules</primary><secondary>left.c</secondary></indexterm>
<indexterm><primary>left.c</primary><secondary>widget_get_btt_label_rules</secondary></indexterm>
<para><computeroutput>const char * widget_get_btt_label_rules ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>&quot;rules&quot; <?linebreak?> </para>
</formalpara>
</para>
</section>
<anchor xml:id="_left_8c_1a22ed4aed09c29d9f8c72dbe7ced53e2c"/><section>
<title>widget_get_btt_label_state()</title>
<indexterm><primary>widget_get_btt_label_state</primary><secondary>left.c</secondary></indexterm>
<indexterm><primary>left.c</primary><secondary>widget_get_btt_label_state</secondary></indexterm>
<para><computeroutput>const char * widget_get_btt_label_state ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>&quot;state&quot; <?linebreak?> </para>
</formalpara>
</para>
</section>
<anchor xml:id="_left_8c_1a3d0f8c7b9545a6da3464060dad7990db"/><section>
<title>widget_get_btt_label_synth()</title>
<indexterm><primary>widget_get_btt_label_synth</primary><secondary>left.c</secondary></indexterm>
<indexterm><primary>left.c</primary><secondary>widget_get_btt_label_synth</secondary></indexterm>
<para><computeroutput>const char * widget_get_btt_label_synth ( )</computeroutput></para><para>
<para><computeroutput>const char * widget_get_btt_label_synth ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>! WARNING ! THE LABELS OF THE PREVIOUS FOUR BUTTONS MUST ONLY BE DEFINED ONCE IN THE PROGRAMME (HERE), AND ONLY USING THE FOUR FOLLOWING FUNCTIONS: </para>
<para>&quot;synth&quot; <?linebreak?> </para>
</formalpara>
</para>
<para>btt_synth </para>
</section>
<anchor xml:id="_left_8c_1a45d8a02844578e1c13d8b86b74e3c8b0"/><section>
<title>window_design_topbar_left()</title>
<indexterm><primary>window_design_topbar_left</primary><secondary>left.c</secondary></indexterm>
<indexterm><primary>left.c</primary><secondary>window_design_topbar_left</secondary></indexterm>
<para><computeroutput>void window_design_topbar_left (GtkWidget * header_bar)</computeroutput></para><para>
<para>The rules page consists of two half-pages in a GtkPaned widget : </para>
</para>
<para><itemizedlist>
<para><computeroutput>void window_design_topbar_left (GtkWidget * header_bar)</computeroutput></para>
<para>The rules page consists of two half-pages in a GtkPaned widget :<itemizedlist>
<listitem>
<para>on the left, widgets for controlling or editing all the rules.</para>
</listitem><listitem>

18
doc/docbook/d5/d05/organize_8c.xml
View File

@ -10,9 +10,7 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../include/base.h&quot;<?linebreak?>#include &quot;../../../../include/signal.h&quot;<?linebreak?>#include &quot;../../../../include/widget.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_organize_8c_1aba1af8256174f6a4661675d2b3c6c34d"/>void * <emphasis role="strong">widget_get_results_box_organize</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_organize_8c_1aba1af8256174f6a4661675d2b3c6c34d">widget_get_results_box_organize</link> ()</para>
</listitem>
</itemizedlist>
</simplesect>
@ -23,4 +21,18 @@
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_organize_8c_1aba1af8256174f6a4661675d2b3c6c34d"/><section>
<title>widget_get_results_box_organize()</title>
<indexterm><primary>widget_get_results_box_organize</primary><secondary>organize.c</secondary></indexterm>
<indexterm><primary>organize.c</primary><secondary>widget_get_results_box_organize</secondary></indexterm>
<para><computeroutput>void * widget_get_results_box_organize ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>GTK_WIDGET (all_box) </para>
</formalpara>
</para>
</section>
</section>
</section>

24
doc/docbook/d5/d0a/modal_8c.xml
View File

@ -11,12 +11,8 @@
<title>Functions </title>
<itemizedlist>
<listitem><para>void <link linkend="_modal_8c_1a2de49d7ea886ac83d68af532046c0868">widget_design_text_window</link> (GtkWindow *main_window, GtkWindow *text_window)</para>
<para>modal </para>
</listitem>
<listitem><para>void * <link linkend="_modal_8c_1a59d241b96357c7580fd8584572f42b4c">widget_get_text_from_address</link> (gchar *text_address)</para>
<para>getter </para>
</listitem>
</itemizedlist>
</simplesect>
@ -33,11 +29,7 @@
<title>widget_design_text_window()</title>
<indexterm><primary>widget_design_text_window</primary><secondary>modal.c</secondary></indexterm>
<indexterm><primary>modal.c</primary><secondary>widget_design_text_window</secondary></indexterm>
<para><computeroutput>void widget_design_text_window (GtkWindow * main_window, GtkWindow * text_window)</computeroutput></para><para>
<para>modal </para>
</para>
<para><computeroutput>void widget_design_text_window (GtkWindow * main_window, GtkWindow * text_window)</computeroutput></para>
<para><formalpara><title>See also</title>
<para>src/widget/modal/widget_get_text_from_address()</para>
@ -75,11 +67,7 @@ Parameters</title>
<title>widget_get_text_from_address()</title>
<indexterm><primary>widget_get_text_from_address</primary><secondary>modal.c</secondary></indexterm>
<indexterm><primary>modal.c</primary><secondary>widget_get_text_from_address</secondary></indexterm>
<para><computeroutput>void * widget_get_text_from_address (gchar * text_address)</computeroutput></para><para>
<para>getter </para>
</para>
<para><computeroutput>void * widget_get_text_from_address (gchar * text_address)</computeroutput></para>
<para><formalpara><title>See also</title>
<para>src/widget/modal/widget_design_text_window()</para>
@ -95,15 +83,17 @@ Parameters</title>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>*text_address</entry><entry>
<para></para>
</entry>
<entry>*text_address</entry><entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>GTK_WIDGET (scrolled_window) </para>
</formalpara>
</para>
</section>
</section>

18
doc/docbook/d6/d07/freq_8c.xml
View File

@ -10,9 +10,7 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../../include/signal.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_freq_8c_1a1f62040452052165b13a8e9bf23ab368"/>void * <emphasis role="strong">widget_get_rules_use</emphasis> ()</para>
<para>phantom documentation </para>
<listitem><para>void * <link linkend="_freq_8c_1a1f62040452052165b13a8e9bf23ab368">widget_get_rules_use</link> ()</para>
</listitem>
</itemizedlist>
</simplesect>
@ -23,4 +21,18 @@
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_freq_8c_1a1f62040452052165b13a8e9bf23ab368"/><section>
<title>widget_get_rules_use()</title>
<indexterm><primary>widget_get_rules_use</primary><secondary>freq.c</secondary></indexterm>
<indexterm><primary>freq.c</primary><secondary>widget_get_rules_use</secondary></indexterm>
<para><computeroutput>void * widget_get_rules_use ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>scroll_rules_use </para>
</formalpara>
</para>
</section>
</section>
</section>

14
doc/docbook/d6/d08/labo_8c.xml
View File

@ -10,9 +10,7 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../../include/widget.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_labo_8c_1a479a32aff9b3fa44b34508e2c41b12d3"/>void <emphasis role="strong">widget_let_us_create_a_complex_useless_and_expensive_tree</emphasis> (struct <link linkend="_structTreeNode__t">TreeNode_t</link> *tree_root)</para>
<para>phantom documentation </para>
<listitem><para>void <link linkend="_labo_8c_1a479a32aff9b3fa44b34508e2c41b12d3">widget_let_us_create_a_complex_useless_and_expensive_tree</link> (struct <link linkend="_structTreeNode__t">TreeNode_t</link> *tree_root)</para>
</listitem>
</itemizedlist>
</simplesect>
@ -23,4 +21,14 @@
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_labo_8c_1a479a32aff9b3fa44b34508e2c41b12d3"/><section>
<title>widget_let_us_create_a_complex_useless_and_expensive_tree()</title>
<indexterm><primary>widget_let_us_create_a_complex_useless_and_expensive_tree</primary><secondary>labo.c</secondary></indexterm>
<indexterm><primary>labo.c</primary><secondary>widget_let_us_create_a_complex_useless_and_expensive_tree</secondary></indexterm>
<para><computeroutput>void widget_let_us_create_a_complex_useless_and_expensive_tree (struct <link linkend="_structTreeNode__t">TreeNode_t</link> * tree_root)</computeroutput></para>
<para>phantom documentation in a phantom tree... </para>
</section>
</section>
</section>

33
doc/docbook/d7/d00/pilot__box_8c.xml
View File

@ -10,13 +10,9 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../../include/signal.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_pilot__box_8c_1a192412673ea82a53a66fd809a5b1fd55"/>void * <emphasis role="strong">widget_get_rules_pilot_box</emphasis> ()</para>
<para>phantom documentation </para>
<listitem><para>void * <link linkend="_pilot__box_8c_1a192412673ea82a53a66fd809a5b1fd55">widget_get_rules_pilot_box</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_pilot__box_8c_1a3cecbcc7340289ed318347f1bf86308c"/>void * <emphasis role="strong">widget_get_rules_tree_tools</emphasis> ()</para>
<para>phantom documentation </para>
<listitem><para>void * <link linkend="_pilot__box_8c_1a3cecbcc7340289ed318347f1bf86308c">widget_get_rules_tree_tools</link> ()</para>
</listitem>
</itemizedlist>
</simplesect>
@ -27,4 +23,29 @@
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_pilot__box_8c_1a192412673ea82a53a66fd809a5b1fd55"/><section>
<title>widget_get_rules_pilot_box()</title>
<indexterm><primary>widget_get_rules_pilot_box</primary><secondary>pilot_box.c</secondary></indexterm>
<indexterm><primary>pilot_box.c</primary><secondary>widget_get_rules_pilot_box</secondary></indexterm>
<para><computeroutput>void * widget_get_rules_pilot_box ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>rules_pilot_box </para>
</formalpara>
</para>
</section>
<anchor xml:id="_pilot__box_8c_1a3cecbcc7340289ed318347f1bf86308c"/><section>
<title>widget_get_rules_tree_tools()</title>
<indexterm><primary>widget_get_rules_tree_tools</primary><secondary>pilot_box.c</secondary></indexterm>
<indexterm><primary>pilot_box.c</primary><secondary>widget_get_rules_tree_tools</secondary></indexterm>
<para><computeroutput>void * widget_get_rules_tree_tools ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>GTK_WIDGET (rules_tree_box) </para>
</formalpara>
</para>
</section>
</section>
</section>

6
doc/docbook/d7/d06/utilities_8c.xml
View File

@ -24,8 +24,6 @@
<title>Functions </title>
<itemizedlist>
<listitem><para>GtkEntry <link linkend="_utilities_8c_1a1c4f1ce489cdc3b4e5a1e86d3438e846">widget_set_item_text</link> (GtkWidget *list_box, const char *text, bool editable)</para>
<para>Format an entry (a text item) in a list. </para>
</listitem>
</itemizedlist>
</simplesect>
@ -44,10 +42,8 @@
<title>widget_set_item_text()</title>
<indexterm><primary>widget_set_item_text</primary><secondary>utilities.c</secondary></indexterm>
<indexterm><primary>utilities.c</primary><secondary>widget_set_item_text</secondary></indexterm>
<para><computeroutput>GtkEntry widget_set_item_text (GtkWidget * list_box, const char * text, bool editable)</computeroutput></para><para>
<para><computeroutput>GtkEntry widget_set_item_text (GtkWidget * list_box, const char * text, bool editable)</computeroutput></para>
<para>Format an entry (a text item) in a list.</para>
</para>
<para><formalpara><title>Since</title>

11
doc/docbook/d7/d07/structStack.xml
View File

@ -2,11 +2,6 @@
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_structStack" xml:lang="en-US">
<title>Stack Struct Reference</title>
<indexterm><primary>Stack</primary></indexterm>
<para>
<para>phantom documentation </para>
</para>
<simplesect>
<title>Public Attributes </title>
<itemizedlist>
@ -23,7 +18,11 @@
<section>
<title>Detailed Description</title>
<para>phantom documentation </para>
<para><formalpara><title>Returns</title>
<para>popped </para>
</formalpara>
</para>
<para>
The documentation for this struct was generated from the following file:</para>
src/widget/main_window/all_rules/compare/<link linkend="_interest_8c">interest.c</link></section>

49
doc/docbook/d8/d06/signal_8c.xml
View File

@ -53,6 +53,10 @@
<listitem><para>void <link linkend="_signal_8c_1acfb2dd4191445aed65fdcbb5e5c14602">on_toggle_state_rules_data</link> (GtkWidget *toggled_button, gpointer widget_all_vs_selected_one)</para>
<para>since 2024-06 </para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1aab85638be623932944de0247e4a5e50e">on_switch_state_rules_data</link> ()</para>
<para>This function could remain static in src/signal. </para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1a9711ba5647a03f97f5966f3fd4b6b487">on_clicked_topbar_right_search</link> (GtkWidget *btt_menu, gpointer list_box)</para>
@ -806,6 +810,51 @@ Parameters</title>
</formalpara>
</para>
</section>
<anchor xml:id="_signal_8c_1aab85638be623932944de0247e4a5e50e"/><section>
<title>on_switch_state_rules_data()</title>
<indexterm><primary>on_switch_state_rules_data</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_switch_state_rules_data</secondary></indexterm>
<para><computeroutput>void on_switch_state_rules_data ( )</computeroutput></para><para>
<para>This function could remain static in src/signal. </para>
</para>
<para>It is provisionally non static to be visible from the documentation (2024-10)</para>
<para><formalpara><title>See also</title>
<para><link linkend="_fsm_8h_1a90ab14081a88752d3721947a4922ee25">fsm_get_state_rules_data()</link> </para>
<para><link linkend="_widget_8h_1aa79c2ff4883932d6f9b7184d1d05dd5d">widget_get_main_window()</link> </para>
<para><link linkend="_widget_8h_1a990f88f46feba957a864d7bf203f42e7">widget_get_page_synth()</link> </para>
<para><link linkend="_widget_8h_1a9689934ad6d7c98379f35d49adf11878">widget_get_page_state()</link> </para>
<para><link linkend="_widget_8h_1a1c074a5748ee5c7e9974bb75539adb34">widget_get_pane_all_rules_left()</link> </para>
<para><link linkend="_widget_8h_1ab9db55b708939397362a8a11489c64c5">widget_get_pane_selected_rule_right()</link></para>
</formalpara>
? see src/widget/main_window/measure/widget_get_page_measure()</para>
<para><formalpara><title>See also</title>
<para>src/widget/main_window/widget_get_page_data()</para>
<para><link linkend="_signal_8c_1af76dc7bf1ffa831f87eff0793960d343">on_toggle_exec_edit()</link> </para>
<para><link linkend="_signal_8c_1acfb2dd4191445aed65fdcbb5e5c14602">on_toggle_state_rules_data()</link></para>
</formalpara>
The rules page consists of two half-pages in a GtkPaned widget :<itemizedlist>
<listitem>
<para>on the left, widgets for controlling or editing all the rules.</para>
</listitem><listitem>
<para>on the right, widgets for controlling or editing the selected rule.</para>
</listitem></itemizedlist>
</para>
<para>Instead of having a: &quot;widget_get_rules_page()&quot; function, this distribution is moved here. (see also widget/topbar/left design) <link linkend="_widget_8h_1a45d8a02844578e1c13d8b86b74e3c8b0">window_design_topbar_left()</link> </para>
</section>
<anchor xml:id="_signal_8c_1af76dc7bf1ffa831f87eff0793960d343"/><section>
<title>on_toggle_exec_edit()</title>
<indexterm><primary>on_toggle_exec_edit</primary><secondary>signal.c</secondary></indexterm>

49
doc/docbook/d8/d09/signal_8h.xml
View File

@ -21,6 +21,10 @@
<listitem><para>void <link linkend="_signal_8h_1aacc95ffe2d93a2b74e1eb1ff429de55d">on_toggle_state_rules_data</link> (GtkWidget *btt_STATE_RULES_DATA, gpointer user_data)</para>
<para>since 2024-06 </para>
</listitem>
<listitem><para>void <link linkend="_signal_8h_1aab85638be623932944de0247e4a5e50e">on_switch_state_rules_data</link> ()</para>
<para>This function could remain static in src/signal. </para>
</listitem>
<listitem><para>void <link linkend="_signal_8h_1a6c7663d555d0c936eecd1d91b3f0ee22">on_save_current_model_before_editing</link> (GtkWidget *btt_SAVE_CURRENT_MODEL, gpointer data)</para>
@ -814,6 +818,51 @@ Parameters</title>
</formalpara>
</para>
</section>
<anchor xml:id="_signal_8h_1aab85638be623932944de0247e4a5e50e"/><section>
<title>on_switch_state_rules_data()</title>
<indexterm><primary>on_switch_state_rules_data</primary><secondary>signal.h</secondary></indexterm>
<indexterm><primary>signal.h</primary><secondary>on_switch_state_rules_data</secondary></indexterm>
<para><computeroutput>void on_switch_state_rules_data ( )</computeroutput></para><para>
<para>This function could remain static in src/signal. </para>
</para>
<para>It is provisionally non static to be visible from the documentation (2024-10)</para>
<para><formalpara><title>See also</title>
<para><link linkend="_fsm_8h_1a90ab14081a88752d3721947a4922ee25">fsm_get_state_rules_data()</link> </para>
<para><link linkend="_widget_8h_1aa79c2ff4883932d6f9b7184d1d05dd5d">widget_get_main_window()</link> </para>
<para><link linkend="_widget_8h_1a990f88f46feba957a864d7bf203f42e7">widget_get_page_synth()</link> </para>
<para><link linkend="_widget_8h_1a9689934ad6d7c98379f35d49adf11878">widget_get_page_state()</link> </para>
<para><link linkend="_widget_8h_1a1c074a5748ee5c7e9974bb75539adb34">widget_get_pane_all_rules_left()</link> </para>
<para><link linkend="_widget_8h_1ab9db55b708939397362a8a11489c64c5">widget_get_pane_selected_rule_right()</link></para>
</formalpara>
? see src/widget/main_window/measure/widget_get_page_measure()</para>
<para><formalpara><title>See also</title>
<para>src/widget/main_window/widget_get_page_data()</para>
<para><link linkend="_signal_8c_1af76dc7bf1ffa831f87eff0793960d343">on_toggle_exec_edit()</link> </para>
<para><link linkend="_signal_8c_1acfb2dd4191445aed65fdcbb5e5c14602">on_toggle_state_rules_data()</link></para>
</formalpara>
The rules page consists of two half-pages in a GtkPaned widget :<itemizedlist>
<listitem>
<para>on the left, widgets for controlling or editing all the rules.</para>
</listitem><listitem>
<para>on the right, widgets for controlling or editing the selected rule.</para>
</listitem></itemizedlist>
</para>
<para>Instead of having a: &quot;widget_get_rules_page()&quot; function, this distribution is moved here. (see also widget/topbar/left design) <link linkend="_widget_8h_1a45d8a02844578e1c13d8b86b74e3c8b0">window_design_topbar_left()</link> </para>
</section>
<anchor xml:id="_signal_8h_1a29b76550faf7263045fc6c17bb1dad06"/><section>
<title>on_toggle_exec_edit()</title>
<indexterm><primary>on_toggle_exec_edit</primary><secondary>signal.h</secondary></indexterm>

243
doc/docbook/d9/d01/widget_2main__window_2measure_2dispatch_8c.xml
View File

@ -10,69 +10,37 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../include/util.h&quot;<?linebreak?>#include &quot;../../../../include/base.h&quot;<?linebreak?>#include &quot;../../../../include/signal.h&quot;<?linebreak?>#include &quot;../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../include/fsm.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a0cef6d510a6777d25e26ec5900c38239"/>void * <emphasis role="strong">widget_measure_event_occurences_nb</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2measure_2dispatch_8c_1a0cef6d510a6777d25e26ec5900c38239">widget_measure_event_occurences_nb</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a3fae10bb44f33d896f72352df671be61"/>void * <emphasis role="strong">widget_measure_event_occurences_dates</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2measure_2dispatch_8c_1a3fae10bb44f33d896f72352df671be61">widget_measure_event_occurences_dates</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a58049a1f53bb6e189b5a60004fd716b5"/>void * <emphasis role="strong">widget_measure_event_occurences_situations</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2measure_2dispatch_8c_1a58049a1f53bb6e189b5a60004fd716b5">widget_measure_event_occurences_situations</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a42113abbf8118a8362314d2427f540dc"/>void * <emphasis role="strong">widget_measure_time_elapsed_between_two_events</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2measure_2dispatch_8c_1a42113abbf8118a8362314d2427f540dc">widget_measure_time_elapsed_between_two_events</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a05bd4127a0e218921c87eb499595f860"/>void * <emphasis role="strong">widget_measure_third_event_occurences_in_between</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2measure_2dispatch_8c_1a05bd4127a0e218921c87eb499595f860">widget_measure_third_event_occurences_in_between</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a5f9f287e97e9bdad13662a864a1d5273"/>void * <emphasis role="strong">widget_measure_do_end_creation_of_measurement_process</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2measure_2dispatch_8c_1a5f9f287e97e9bdad13662a864a1d5273">widget_measure_do_end_creation_of_measurement_process</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a3d1ceccb1f00d0a2f3329af8b499844b"/>void * <emphasis role="strong">widget_measure_do_insert_in_measurements_list</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2measure_2dispatch_8c_1a3d1ceccb1f00d0a2f3329af8b499844b">widget_measure_do_insert_in_measurements_list</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1aaab2ef1ae64c85052ab65ed684f3a132"/>void * <emphasis role="strong">widget_measure_do_correlate</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2measure_2dispatch_8c_1aaab2ef1ae64c85052ab65ed684f3a132">widget_measure_do_correlate</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a5b3aeea035afbf3cb35744687f091b1b"/>void * <emphasis role="strong">widget_measure_do_depends_on_a_single_event</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2measure_2dispatch_8c_1a5b3aeea035afbf3cb35744687f091b1b">widget_measure_do_depends_on_a_single_event</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a444bf6c3230e0f97827eda74818ba258"/>void * <emphasis role="strong">widget_measure_do_select_a_second_rules_set</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2measure_2dispatch_8c_1a444bf6c3230e0f97827eda74818ba258">widget_measure_do_select_a_second_rules_set</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a37872533aa0116818c810d9cdad7f4ed"/>void * <emphasis role="strong">widget_measure_do_choose_an_event_type</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2measure_2dispatch_8c_1a37872533aa0116818c810d9cdad7f4ed">widget_measure_do_choose_an_event_type</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a27574b02d486a2e93ed1a3e0f6461798"/>void * <emphasis role="strong">widget_measure_new</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2measure_2dispatch_8c_1a27574b02d486a2e93ed1a3e0f6461798">widget_measure_new</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a7c86507328bb9c31a0dcc0c97cf66c25"/>void * <emphasis role="strong">widget_measure_do_depends_on_two_events</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2measure_2dispatch_8c_1a7c86507328bb9c31a0dcc0c97cf66c25">widget_measure_do_depends_on_two_events</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1aea7a46578d6e1f0a2ee58b0f6eb16028"/>void * <emphasis role="strong">widget_measure_do_depends_on_one_or_two_events</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2measure_2dispatch_8c_1aea7a46578d6e1f0a2ee58b0f6eb16028">widget_measure_do_depends_on_one_or_two_events</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a88886ed08e68539a9c5280fc40c2c2a0"/>void * <emphasis role="strong">widget_measure_do_select_rules_first</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2measure_2dispatch_8c_1a88886ed08e68539a9c5280fc40c2c2a0">widget_measure_do_select_rules_first</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1afabb3345620886cdee4f2b76c9d84a51"/>void * <emphasis role="strong">widget_get_page_measure</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2measure_2dispatch_8c_1afabb3345620886cdee4f2b76c9d84a51">widget_get_page_measure</link> ()</para>
</listitem>
</itemizedlist>
</simplesect>
@ -83,4 +51,183 @@
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1afabb3345620886cdee4f2b76c9d84a51"/><section>
<title>widget_get_page_measure()</title>
<indexterm><primary>widget_get_page_measure</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_get_page_measure</secondary></indexterm>
<para><computeroutput>void * widget_get_page_measure ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>measure_page </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a37872533aa0116818c810d9cdad7f4ed"/><section>
<title>widget_measure_do_choose_an_event_type()</title>
<indexterm><primary>widget_measure_do_choose_an_event_type</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_measure_do_choose_an_event_type</secondary></indexterm>
<para><computeroutput>void * widget_measure_do_choose_an_event_type ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>measure_page </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1aaab2ef1ae64c85052ab65ed684f3a132"/><section>
<title>widget_measure_do_correlate()</title>
<indexterm><primary>widget_measure_do_correlate</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_measure_do_correlate</secondary></indexterm>
<para><computeroutput>void * widget_measure_do_correlate ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>measure_page </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a5b3aeea035afbf3cb35744687f091b1b"/><section>
<title>widget_measure_do_depends_on_a_single_event()</title>
<indexterm><primary>widget_measure_do_depends_on_a_single_event</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_measure_do_depends_on_a_single_event</secondary></indexterm>
<para><computeroutput>void * widget_measure_do_depends_on_a_single_event ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>measure_page </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1aea7a46578d6e1f0a2ee58b0f6eb16028"/><section>
<title>widget_measure_do_depends_on_one_or_two_events()</title>
<indexterm><primary>widget_measure_do_depends_on_one_or_two_events</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_measure_do_depends_on_one_or_two_events</secondary></indexterm>
<para><computeroutput>void * widget_measure_do_depends_on_one_or_two_events ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>measure_page </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a7c86507328bb9c31a0dcc0c97cf66c25"/><section>
<title>widget_measure_do_depends_on_two_events()</title>
<indexterm><primary>widget_measure_do_depends_on_two_events</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_measure_do_depends_on_two_events</secondary></indexterm>
<para><computeroutput>void * widget_measure_do_depends_on_two_events ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>NULL </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a5f9f287e97e9bdad13662a864a1d5273"/><section>
<title>widget_measure_do_end_creation_of_measurement_process()</title>
<indexterm><primary>widget_measure_do_end_creation_of_measurement_process</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_measure_do_end_creation_of_measurement_process</secondary></indexterm>
<para><computeroutput>void * widget_measure_do_end_creation_of_measurement_process ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>measure_page </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a3d1ceccb1f00d0a2f3329af8b499844b"/><section>
<title>widget_measure_do_insert_in_measurements_list()</title>
<indexterm><primary>widget_measure_do_insert_in_measurements_list</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_measure_do_insert_in_measurements_list</secondary></indexterm>
<para><computeroutput>void * widget_measure_do_insert_in_measurements_list ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>measure_page </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a444bf6c3230e0f97827eda74818ba258"/><section>
<title>widget_measure_do_select_a_second_rules_set()</title>
<indexterm><primary>widget_measure_do_select_a_second_rules_set</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_measure_do_select_a_second_rules_set</secondary></indexterm>
<para><computeroutput>void * widget_measure_do_select_a_second_rules_set ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>measure_page </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a88886ed08e68539a9c5280fc40c2c2a0"/><section>
<title>widget_measure_do_select_rules_first()</title>
<indexterm><primary>widget_measure_do_select_rules_first</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_measure_do_select_rules_first</secondary></indexterm>
<para><computeroutput>void * widget_measure_do_select_rules_first ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>measure_page </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a3fae10bb44f33d896f72352df671be61"/><section>
<title>widget_measure_event_occurences_dates()</title>
<indexterm><primary>widget_measure_event_occurences_dates</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_measure_event_occurences_dates</secondary></indexterm>
<para><computeroutput>void * widget_measure_event_occurences_dates ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>measure_page </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a0cef6d510a6777d25e26ec5900c38239"/><section>
<title>widget_measure_event_occurences_nb()</title>
<indexterm><primary>widget_measure_event_occurences_nb</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_measure_event_occurences_nb</secondary></indexterm>
<para><computeroutput>void * widget_measure_event_occurences_nb ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>measure_page </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a58049a1f53bb6e189b5a60004fd716b5"/><section>
<title>widget_measure_event_occurences_situations()</title>
<indexterm><primary>widget_measure_event_occurences_situations</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_measure_event_occurences_situations</secondary></indexterm>
<para><computeroutput>void * widget_measure_event_occurences_situations ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>measure_page </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a27574b02d486a2e93ed1a3e0f6461798"/><section>
<title>widget_measure_new()</title>
<indexterm><primary>widget_measure_new</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_measure_new</secondary></indexterm>
<para><computeroutput>void * widget_measure_new ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>NULL </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a05bd4127a0e218921c87eb499595f860"/><section>
<title>widget_measure_third_event_occurences_in_between()</title>
<indexterm><primary>widget_measure_third_event_occurences_in_between</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_measure_third_event_occurences_in_between</secondary></indexterm>
<para><computeroutput>void * widget_measure_third_event_occurences_in_between ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>measure_page </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2main__window_2measure_2dispatch_8c_1a42113abbf8118a8362314d2427f540dc"/><section>
<title>widget_measure_time_elapsed_between_two_events()</title>
<indexterm><primary>widget_measure_time_elapsed_between_two_events</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_measure_time_elapsed_between_two_events</secondary></indexterm>
<para><computeroutput>void * widget_measure_time_elapsed_between_two_events ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>measure_page </para>
</formalpara>
</para>
</section>
</section>
</section>

20
doc/docbook/d9/d0d/interest_8c.xml
View File

@ -11,8 +11,6 @@
<title>Classes </title>
<itemizedlist>
<listitem><para>struct <link linkend="_structStack">Stack</link></para>
<para>phantom documentation </para>
</listitem>
</itemizedlist>
</simplesect>
@ -32,9 +30,7 @@
<simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_interest_8c_1a60d9aed440437cd898f609784c32b2f5"/>void * <emphasis role="strong">widget_get_an_impression_of_what_a_rules_comparator_could_be</emphasis> ()</para>
<para>phantom documentation </para>
<listitem><para>void * <link linkend="_interest_8c_1a60d9aed440437cd898f609784c32b2f5">widget_get_an_impression_of_what_a_rules_comparator_could_be</link> ()</para>
</listitem>
</itemizedlist>
</simplesect>
@ -45,4 +41,18 @@
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_interest_8c_1a60d9aed440437cd898f609784c32b2f5"/><section>
<title>widget_get_an_impression_of_what_a_rules_comparator_could_be()</title>
<indexterm><primary>widget_get_an_impression_of_what_a_rules_comparator_could_be</primary><secondary>interest.c</secondary></indexterm>
<indexterm><primary>interest.c</primary><secondary>widget_get_an_impression_of_what_a_rules_comparator_could_be</secondary></indexterm>
<para><computeroutput>void * widget_get_an_impression_of_what_a_rules_comparator_could_be ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>comparator </para>
</formalpara>
</para>
</section>
</section>
</section>

38
doc/docbook/da/d0e/center_8c.xml
View File

@ -4,21 +4,49 @@
<indexterm><primary>src/widget/main_window/topbar/center.c</primary></indexterm>
<para>
<para>Topbar center. </para>
<para>Topbar center design. </para>
</para>
<programlisting linenumbering="unnumbered">#include &quot;../../../../include/base.h&quot;<?linebreak?>#include &quot;../../../../include/signal.h&quot;<?linebreak?>#include &quot;../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../include/fsm.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_center_8c_1a149992300a77b245016ed0e1984651d4"/>void <emphasis role="strong">window_design_topbar_center</emphasis> (GtkWidget *topbar)</para>
<para>title </para>
<listitem><para>void <link linkend="_center_8c_1a149992300a77b245016ed0e1984651d4">window_design_topbar_center</link> (GtkWidget *topbar)</para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>Topbar center. </para>
<para>Topbar center design. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_center_8c_1a149992300a77b245016ed0e1984651d4"/><section>
<title>window_design_topbar_center()</title>
<indexterm><primary>window_design_topbar_center</primary><secondary>center.c</secondary></indexterm>
<indexterm><primary>center.c</primary><secondary>window_design_topbar_center</secondary></indexterm>
<para><computeroutput>void window_design_topbar_center (GtkWidget * topbar)</computeroutput></para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>*topbar</entry><entry>
<para></para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
</para>
</section>
</section>
</section>

10
doc/docbook/db/d02/designer_8c.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>src/widget/main_window/designer.c</primary></indexterm>
<para>
<para>builds ans present </para>
<para>designs and presents </para>
</para>
<programlisting linenumbering="unnumbered">#include &quot;../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../include/util.h&quot;<?linebreak?></programlisting><simplesect>
@ -17,11 +17,9 @@
<section>
<title>Detailed Description</title>
<para>builds ans present </para>
<para>designs and presents </para>
<para>This file is part of Gem-graph.</para>
<para>ensure the titlebar and the pages are available and init them</para>
<para>ensures the titlebar and the pages are available and init them</para>
<para>triggers assembly of the topbar and the default page</para>
@ -39,7 +37,7 @@
<para>&#8205;the &quot;all rules&quot; page gives access to the hierarchy of all rules </para>
</blockquote><blockquote>
<para>&#8205;the &quot;selected rule&quot; page lets you examine and modify one selected rule </para>
</blockquote></para>
</blockquote>This file is part of Gem-graph. </para>
</listitem></itemizedlist>
</para>
</section>

18
doc/docbook/db/d02/geometry_8c.xml
View File

@ -10,9 +10,7 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../../include/signal.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_geometry_8c_1a075009e3b1816abfd76bd3d4fcdda890"/>void * <emphasis role="strong">widget_get_selected_rule_before_after</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_geometry_8c_1a075009e3b1816abfd76bd3d4fcdda890">widget_get_selected_rule_before_after</link> ()</para>
</listitem>
</itemizedlist>
</simplesect>
@ -23,4 +21,18 @@
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_geometry_8c_1a075009e3b1816abfd76bd3d4fcdda890"/><section>
<title>widget_get_selected_rule_before_after()</title>
<indexterm><primary>widget_get_selected_rule_before_after</primary><secondary>geometry.c</secondary></indexterm>
<indexterm><primary>geometry.c</primary><secondary>widget_get_selected_rule_before_after</secondary></indexterm>
<para><computeroutput>void * widget_get_selected_rule_before_after ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>GTK_WIDGET (before_vs_after) </para>
</formalpara>
</para>
</section>
</section>
</section>

33
doc/docbook/db/d05/display_8c.xml
View File

@ -10,13 +10,9 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../include/base.h&quot;<?linebreak?>#include &quot;../../../../include/signal.h&quot;<?linebreak?>#include &quot;../../../../include/widget.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_display_8c_1a1cc6f65cd162b7c49e760ab29e8b7919"/>void * <emphasis role="strong">widget_get_results_box_time</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_display_8c_1a1cc6f65cd162b7c49e760ab29e8b7919">widget_get_results_box_time</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_display_8c_1aeca06e5a8c669b8d8f9dd82289f4e1e1"/>void * <emphasis role="strong">widget_get_results_box_display</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_display_8c_1aeca06e5a8c669b8d8f9dd82289f4e1e1">widget_get_results_box_display</link> ()</para>
</listitem>
</itemizedlist>
</simplesect>
@ -27,4 +23,29 @@
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_display_8c_1aeca06e5a8c669b8d8f9dd82289f4e1e1"/><section>
<title>widget_get_results_box_display()</title>
<indexterm><primary>widget_get_results_box_display</primary><secondary>display.c</secondary></indexterm>
<indexterm><primary>display.c</primary><secondary>widget_get_results_box_display</secondary></indexterm>
<para><computeroutput>void * widget_get_results_box_display ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>GTK_WIDGET (data_box) </para>
</formalpara>
</para>
</section>
<anchor xml:id="_display_8c_1a1cc6f65cd162b7c49e760ab29e8b7919"/><section>
<title>widget_get_results_box_time()</title>
<indexterm><primary>widget_get_results_box_time</primary><secondary>display.c</secondary></indexterm>
<indexterm><primary>display.c</primary><secondary>widget_get_results_box_time</secondary></indexterm>
<para><computeroutput>void * widget_get_results_box_time ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>GTK_WIDGET (time_box) </para>
</formalpara>
</para>
</section>
</section>
</section>

48
doc/docbook/db/d06/widget_2main__window_2synth_2dispatch_8c.xml
View File

@ -10,17 +10,11 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../include/base.h&quot;<?linebreak?>#include &quot;../../../../include/signal.h&quot;<?linebreak?>#include &quot;../../../../include/widget.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_widget_2main__window_2synth_2dispatch_8c_1abc35a23e7853e1e3628b389291f29cba"/>void * <emphasis role="strong">widget_get_non_time_dependent</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2synth_2dispatch_8c_1abc35a23e7853e1e3628b389291f29cba">widget_get_non_time_dependent</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_2main__window_2synth_2dispatch_8c_1aed9b242acda234a0ca5cd359cb6d29e2"/>void * <emphasis role="strong">widget_get_space_vs_non_time_dependent</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2synth_2dispatch_8c_1aed9b242acda234a0ca5cd359cb6d29e2">widget_get_space_vs_non_time_dependent</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_2main__window_2synth_2dispatch_8c_1a990f88f46feba957a864d7bf203f42e7"/>void * <emphasis role="strong">widget_get_page_synth</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2synth_2dispatch_8c_1a990f88f46feba957a864d7bf203f42e7">widget_get_page_synth</link> ()</para>
</listitem>
</itemizedlist>
</simplesect>
@ -29,4 +23,40 @@
<para>main_window synthetic view </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_widget_2main__window_2synth_2dispatch_8c_1abc35a23e7853e1e3628b389291f29cba"/><section>
<title>widget_get_non_time_dependent()</title>
<indexterm><primary>widget_get_non_time_dependent</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_get_non_time_dependent</secondary></indexterm>
<para><computeroutput>void * widget_get_non_time_dependent ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>results_box </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2main__window_2synth_2dispatch_8c_1a990f88f46feba957a864d7bf203f42e7"/><section>
<title>widget_get_page_synth()</title>
<indexterm><primary>widget_get_page_synth</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_get_page_synth</secondary></indexterm>
<para><computeroutput>void * widget_get_page_synth ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>space_and_analysis_vs_history </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2main__window_2synth_2dispatch_8c_1aed9b242acda234a0ca5cd359cb6d29e2"/><section>
<title>widget_get_space_vs_non_time_dependent()</title>
<indexterm><primary>widget_get_space_vs_non_time_dependent</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_get_space_vs_non_time_dependent</secondary></indexterm>
<para><computeroutput>void * widget_get_space_vs_non_time_dependent ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>space_vs_non_time_dependent_analysis </para>
</formalpara>
</para>
</section>
</section>
</section>

6
doc/docbook/db/d07/assign_8c.xml
View File

@ -11,8 +11,6 @@
<title>Functions </title>
<itemizedlist>
<listitem><para>void * <link linkend="_assign_8c_1a9020593f4cd1b7f9dd85dd383523474c">widget_get_selected_rule_assignments_list_btt</link> ()</para>
<para>Presents the list of all the elementary actions (assignments) performed when the rule is applied. </para>
</listitem>
</itemizedlist>
</simplesect>
@ -29,10 +27,8 @@
<title>widget_get_selected_rule_assignments_list_btt()</title>
<indexterm><primary>widget_get_selected_rule_assignments_list_btt</primary><secondary>assign.c</secondary></indexterm>
<indexterm><primary>assign.c</primary><secondary>widget_get_selected_rule_assignments_list_btt</secondary></indexterm>
<para><computeroutput>void * widget_get_selected_rule_assignments_list_btt ( )</computeroutput></para><para>
<para><computeroutput>void * widget_get_selected_rule_assignments_list_btt ( )</computeroutput></para>
<para>Presents the list of all the elementary actions (assignments) performed when the rule is applied.</para>
</para>
<para>Today, an arbitrary presentation with no link to the XML model and no verification of compliance with the meta-rules. (see below) TODO</para>

33
doc/docbook/db/d07/bottom_8c.xml
View File

@ -10,13 +10,9 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../include/signal.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_bottom_8c_1affbfa87fb5a08853b9a4d92de8877ff7"/>void * <emphasis role="strong">widget_get_space_edit_control</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_bottom_8c_1affbfa87fb5a08853b9a4d92de8877ff7">widget_get_space_edit_control</link> ()</para>
</listitem>
<listitem><para><anchor xml:id="_bottom_8c_1a593c9c15eb7c193c589dac7c28c36560"/>void * <emphasis role="strong">widget_get_sequence_control</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_bottom_8c_1a593c9c15eb7c193c589dac7c28c36560">widget_get_sequence_control</link> ()</para>
</listitem>
</itemizedlist>
</simplesect>
@ -25,4 +21,29 @@
<para>main_window state view &gt; bottom part of the view </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_bottom_8c_1a593c9c15eb7c193c589dac7c28c36560"/><section>
<title>widget_get_sequence_control()</title>
<indexterm><primary>widget_get_sequence_control</primary><secondary>bottom.c</secondary></indexterm>
<indexterm><primary>bottom.c</primary><secondary>widget_get_sequence_control</secondary></indexterm>
<para><computeroutput>void * widget_get_sequence_control ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>GTK_WIDGET (SEQUENCE_CONTROL_box) </para>
</formalpara>
</para>
</section>
<anchor xml:id="_bottom_8c_1affbfa87fb5a08853b9a4d92de8877ff7"/><section>
<title>widget_get_space_edit_control()</title>
<indexterm><primary>widget_get_space_edit_control</primary><secondary>bottom.c</secondary></indexterm>
<indexterm><primary>bottom.c</primary><secondary>widget_get_space_edit_control</secondary></indexterm>
<para><computeroutput>void * widget_get_space_edit_control ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>GTK_WIDGET (&quot;SPACE EDIT&quot;) </para>
</formalpara>
</para>
</section>
</section>
</section>

15
doc/docbook/dc/d04/top_8c.xml
View File

@ -16,9 +16,7 @@
</listitem>
<listitem><para>void <link linkend="_top_8c_1a4081353ac1420fa15533a11bcbff3238">widget_set_situations_value</link> (int value)</para>
</listitem>
<listitem><para><anchor xml:id="_top_8c_1a86794ff6578c24e8b16b94bf853dd2b3"/>void * <emphasis role="strong">widget_get_graph_view_control</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_top_8c_1a86794ff6578c24e8b16b94bf853dd2b3">widget_get_graph_view_control</link> ()</para>
</listitem>
</itemizedlist>
</simplesect>
@ -29,6 +27,17 @@
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_top_8c_1a86794ff6578c24e8b16b94bf853dd2b3"/><section>
<title>widget_get_graph_view_control()</title>
<indexterm><primary>widget_get_graph_view_control</primary><secondary>top.c</secondary></indexterm>
<indexterm><primary>top.c</primary><secondary>widget_get_graph_view_control</secondary></indexterm>
<para><computeroutput>void * widget_get_graph_view_control ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>objects_vs_situations_horizontal_pane </para>
</formalpara>
</para>
</section>
<anchor xml:id="_top_8c_1a7567acc9ecaf9b3e6d06c08b60c50142"/><section>
<title>widget_get_object_transparency()</title>
<indexterm><primary>widget_get_object_transparency</primary><secondary>top.c</secondary></indexterm>

14
doc/docbook/dc/d0b/disp__list_8c.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>src/fsm/measures/disp_list.c</primary></indexterm>
<para>
<para>a list of displayable results, including those currently displayed Gem-graph-client list (and current use) </para>
<para>A list of displayable results (whether currently displayed or not). </para>
</para>
<programlisting linenumbering="unnumbered">#include &lt;stdbool.h&gt;<?linebreak?>#include &lt;stdio.h&gt;<?linebreak?>#include &lt;stdlib.h&gt;<?linebreak?>#include &quot;../../../include/fsm.h&quot;<?linebreak?></programlisting><simplesect>
@ -21,9 +21,17 @@
<section>
<title>Detailed Description</title>
<para>a list of displayable results, including those currently displayed Gem-graph-client list (and current use) </para>
<para>A list of displayable results (whether currently displayed or not). </para>
<para>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. <formalpara><title>See also</title>
<para>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.</para>
<para>The format of the results must be compatible with the formats recognised by the usual presentation software.</para>
<para>&quot;graph&quot;, &quot;chart&quot;, &quot;plot&quot; and &quot;diagram&quot; are ambiguous terms, used interchangeably.</para>
<para>NB some data may be displayed simultaneously in different pages ex : pages &apos;synth&apos; &amp; &apos;results&apos;</para>
<para><formalpara><title>See also</title>
<para>: fsm/measure/manage.c </para>
</formalpara>

18
doc/docbook/dc/d0c/widget_2main__window_2results_2dispatch_8c.xml
View File

@ -10,9 +10,7 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../include/base.h&quot;<?linebreak?>#include &quot;../../../../include/signal.h&quot;<?linebreak?>#include &quot;../../../../include/widget.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_widget_2main__window_2results_2dispatch_8c_1a56cdc1609820a67a52fb095ba0128d3f"/>void * <emphasis role="strong">widget_get_page_data</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2results_2dispatch_8c_1a56cdc1609820a67a52fb095ba0128d3f">widget_get_page_data</link> ()</para>
</listitem>
</itemizedlist>
</simplesect>
@ -23,4 +21,18 @@
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_widget_2main__window_2results_2dispatch_8c_1a56cdc1609820a67a52fb095ba0128d3f"/><section>
<title>widget_get_page_data()</title>
<indexterm><primary>widget_get_page_data</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_get_page_data</secondary></indexterm>
<para><computeroutput>void * widget_get_page_data ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>measures_and_results </para>
</formalpara>
</para>
</section>
</section>
</section>

10
doc/docbook/dc/d0e/widget_2main__window_2one__rule_2algebra_2dispatch_8c.xml
View File

@ -11,8 +11,6 @@
<title>Functions </title>
<itemizedlist>
<listitem><para>void * <link linkend="_widget_2main__window_2one__rule_2algebra_2dispatch_8c_1a15cbd8402e76ff0dd5e6b39e17a9dc49">widget_get_selected_rule_algebra</link> ()</para>
<para>Provides the three lists needed to describe a rule algebraically. </para>
</listitem>
</itemizedlist>
</simplesect>
@ -31,10 +29,8 @@
<title>widget_get_selected_rule_algebra()</title>
<indexterm><primary>widget_get_selected_rule_algebra</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_get_selected_rule_algebra</secondary></indexterm>
<para><computeroutput>void * widget_get_selected_rule_algebra ( )</computeroutput></para><para>
<para><computeroutput>void * widget_get_selected_rule_algebra ( )</computeroutput></para>
<para>Provides the three lists needed to describe a rule algebraically.</para>
</para>
<para>The algebraic definition of a rule comprises three types of character strings organised into three lists:<itemizedlist>
<listitem>
@ -60,6 +56,10 @@
<para>src/widget/one_rule/dispatch()</para>
</formalpara>
<formalpara><title>Returns</title>
<para>GTK_WIDGET (conditions_actions_names_box) </para>
</formalpara>
</para>
</section>
</section>

8
doc/docbook/dd/d01/fsm_8h.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>include/fsm.h</primary></indexterm>
<para>
<para>fsm (Finite State Machine) header </para>
<para>FSM (Finite State Machine) header. </para>
</para>
<programlisting linenumbering="unnumbered">#include &lt;stdbool.h&gt;<?linebreak?>#include &lt;stddef.h&gt;<?linebreak?>#include &lt;string.h&gt;<?linebreak?>#include &lt;gtk-4.0/gtk/gtk.h&gt;<?linebreak?></programlisting><simplesect>
@ -110,7 +110,7 @@
, <?linebreak?><emphasis role="strong">RULES_PAGE</emphasis>
, <emphasis role="strong">MEASURES_PAGE</emphasis>
, <emphasis role="strong">RESULTS_PAGE</emphasis>
, <emphasis role="strong">SenumYNTH_GLAREA</emphasis>
, <emphasis role="strong">SYNTH_GLAREA</emphasis>
, <?linebreak?><emphasis role="strong">SYNTH_ALL_RESULTS</emphasis>
, <emphasis role="strong">SYNTH_TIME_DEP_RESULTS</emphasis>
, <emphasis role="strong">SYNTH_TIME_INDEP_RESULTS</emphasis>
@ -144,7 +144,7 @@
, <emphasis role="strong">SLIDER</emphasis>
, <emphasis role="strong">EXPANDER</emphasis>
, <?linebreak?><emphasis role="strong">ENTRY</emphasis>
, <emphasis role="strong">SWITCH_STATE_RULES_DATA</emphasis>
, <emphasis role="strong">ON_SWITCH_STATE_RULES_DATA</emphasis>
, <emphasis role="strong">SLIDER_X</emphasis>
, <emphasis role="strong">SLIDER_Y</emphasis>
, <?linebreak?><emphasis role="strong">SLIDER_Z</emphasis>
@ -318,7 +318,7 @@
<section>
<title>Detailed Description</title>
<para>fsm (Finite State Machine) header </para>
<para>FSM (Finite State Machine) header. </para>
<para>This file is part of Gem-graph. </para>
</section>

8
doc/docbook/dd/d09/dialog_8c.xml
View File

@ -11,8 +11,6 @@
<title>Functions </title>
<itemizedlist>
<listitem><para>void <link linkend="_dialog_8c_1a1591b0ceef41a3926eee69905735b3ec">widget_design_dialog_window</link> (GtkWindow *main_window, GtkWindow *dialog_window)</para>
<para>modal </para>
</listitem>
</itemizedlist>
</simplesect>
@ -29,11 +27,7 @@
<title>widget_design_dialog_window()</title>
<indexterm><primary>widget_design_dialog_window</primary><secondary>dialog.c</secondary></indexterm>
<indexterm><primary>dialog.c</primary><secondary>widget_design_dialog_window</secondary></indexterm>
<para><computeroutput>void widget_design_dialog_window (GtkWindow * main_window, GtkWindow * dialog_window)</computeroutput></para><para>
<para>modal </para>
</para>
<para><computeroutput>void widget_design_dialog_window (GtkWindow * main_window, GtkWindow * dialog_window)</computeroutput></para>
<para><formalpara><title>See also</title>
<para>src/fsm/dispatch/fsm_journal_event()</para>

6
doc/docbook/de/d0e/conditions_8c.xml
View File

@ -11,8 +11,6 @@
<title>Functions </title>
<itemizedlist>
<listitem><para>void * <link linkend="_conditions_8c_1a8d42128cf54da36d55112fa5f5634f96">widget_get_selected_rule_conditions_list_btt</link> ()</para>
<para>Builds and presents the conditions list of a rule. </para>
</listitem>
</itemizedlist>
</simplesect>
@ -29,10 +27,8 @@
<title>widget_get_selected_rule_conditions_list_btt()</title>
<indexterm><primary>widget_get_selected_rule_conditions_list_btt</primary><secondary>conditions.c</secondary></indexterm>
<indexterm><primary>conditions.c</primary><secondary>widget_get_selected_rule_conditions_list_btt</secondary></indexterm>
<para><computeroutput>void * widget_get_selected_rule_conditions_list_btt ( )</computeroutput></para><para>
<para><computeroutput>void * widget_get_selected_rule_conditions_list_btt ( )</computeroutput></para>
<para>Builds and presents the conditions list of a rule.</para>
</para>
<para>This list sets out all the conditions that the rule must meet in order to be applied.</para>

18
doc/docbook/df/d03/time_8c.xml
View File

@ -10,9 +10,7 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../include/base.h&quot;<?linebreak?>#include &quot;../../../../include/signal.h&quot;<?linebreak?>#include &quot;../../../../include/widget.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_time_8c_1aff18a7cea4191d9ae0480f2eaca06a5f"/>void * <emphasis role="strong">widget_get_time_dependent</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_time_8c_1aff18a7cea4191d9ae0480f2eaca06a5f">widget_get_time_dependent</link> ()</para>
</listitem>
</itemizedlist>
</simplesect>
@ -21,4 +19,18 @@
<para>main_window synthetic view time dependent functions </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_time_8c_1aff18a7cea4191d9ae0480f2eaca06a5f"/><section>
<title>widget_get_time_dependent()</title>
<indexterm><primary>widget_get_time_dependent</primary><secondary>time.c</secondary></indexterm>
<indexterm><primary>time.c</primary><secondary>widget_get_time_dependent</secondary></indexterm>
<para><computeroutput>void * widget_get_time_dependent ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
<para>time_box </para>
</formalpara>
</para>
</section>
</section>
</section>

894
doc/docbook/df/d05/widget_8h.xml
View File

File diff suppressed because it is too large Load Diff

24
doc/docbook/df/d06/widget_2main__window_2one__rule_2geometry_2dispatch_8c.xml
View File

@ -10,9 +10,7 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../../include/signal.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_widget_2main__window_2one__rule_2geometry_2dispatch_8c_1a303a3e0838137d31f4e04a416ebf6310"/>void * <emphasis role="strong">widget_get_selected_rule_geometry</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2one__rule_2geometry_2dispatch_8c_1a303a3e0838137d31f4e04a416ebf6310">widget_get_selected_rule_geometry</link> ()</para>
</listitem>
</itemizedlist>
</simplesect>
@ -23,4 +21,24 @@
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_widget_2main__window_2one__rule_2geometry_2dispatch_8c_1a303a3e0838137d31f4e04a416ebf6310"/><section>
<title>widget_get_selected_rule_geometry()</title>
<indexterm><primary>widget_get_selected_rule_geometry</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_get_selected_rule_geometry</secondary></indexterm>
<para><computeroutput>void * widget_get_selected_rule_geometry ( )</computeroutput></para>
<para>split two images versus camera</para>
<para><formalpara><title>See also</title>
<para>src/widget/main_window/one_rule/dispatch/widget_get_selected_rule()</para>
<para><link linkend="_widget_8h_1a075009e3b1816abfd76bd3d4fcdda890">widget_get_selected_rule_before_after()</link> </para>
<para><link linkend="_widget_8h_1a1b97f8be0394a44033a491d7bb44dce2">widget_get_selected_rule_camera()</link> </para>
</formalpara>
</para>
</section>
</section>
</section>

82
doc/docbook/df/d0e/widget_2main__window_2state_2dispatch_8c.xml
View File

@ -10,9 +10,7 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../include/signal.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_widget_2main__window_2state_2dispatch_8c_1a9689934ad6d7c98379f35d49adf11878"/>void * <emphasis role="strong">widget_get_page_state</emphasis> ()</para>
<para>Phantom documentation. </para>
<listitem><para>void * <link linkend="_widget_2main__window_2state_2dispatch_8c_1a9689934ad6d7c98379f35d49adf11878">widget_get_page_state</link> ()</para>
</listitem>
</itemizedlist>
</simplesect>
@ -20,5 +18,83 @@
<title>Detailed Description</title>
<para>main_window state view dispatcher </para>
<para>The only function here is <link linkend="_widget_2main__window_2state_2dispatch_8c_1a9689934ad6d7c98379f35d49adf11878">widget_get_page_state()</link> which defines the structure of the state page. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_widget_2main__window_2state_2dispatch_8c_1a9689934ad6d7c98379f35d49adf11878"/><section>
<title>widget_get_page_state()</title>
<indexterm><primary>widget_get_page_state</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_get_page_state</secondary></indexterm>
<para><computeroutput>void * widget_get_page_state ( )</computeroutput></para>
<para>L&apos;image de l&apos;état de l&apos;espace (au centre) fait partie d&apos;un panneau &quot;milieu&quot;, qui est encadré par les deux panneaux: &quot;haut&quot; et &quot;bas&quot;. La partie droite du panneau &quot;milieu&quot; est elle-même un panneau de commandes.</para>
<para>Si l&apos;on nomme ces panneaux selon leur fonction, on trouvera:<itemizedlist>
<listitem>
<para>CONTROL ou EDIT en bas permet de contrôler / choisir un état et / ou de l&apos;éditer. ce panneau peut avoir deux apparences (et fonctions) différentes:<itemizedlist>
<listitem>
<para>en mode EDIT, seuls les outils d&apos;édition de l&apos;état sont disponibles</para>
</listitem><listitem>
<para>en mode EXEC, seuls les outils de déplacement dans la séquence sont disponibles</para>
</listitem></itemizedlist>
</para>
</listitem><listitem>
<para>CAMERA à droite permet de choisir la position de la caméra</para>
</listitem><listitem>
<para>CONTRAST en haut permet de modifier un à un les contrastes des objets et des situations afin de mieux mettre en évidence l&apos;objet ou le phénomène d&apos;intérêt</para>
</listitem></itemizedlist>
</para>
<para><informaltable frame='bottom'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>
</entry></row></tbody></tgroup></informaltable>
</para>
<para>The state page is horizontally divided in three sections</para>
<para><itemizedlist>
<listitem>
<para>top: controls on the colors or transparencies of the model objects</para>
</listitem><listitem>
<para>middle: space view on the left / camera on the right</para>
</listitem><listitem>
<para>bottom: depends on the fsm exec/edit state</para>
</listitem><listitem>
<para>- if fsm in on exec mode, bottom displays sequence control widgets</para>
</listitem><listitem>
<para>- if fsm in on edit mode, bottom displays space edition control widgets</para>
</listitem></itemizedlist>
</para>
<para><informaltable frame='bottom'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>
</entry></row></tbody></tgroup></informaltable>
</para>
<para><formalpara><title>See also</title>
<para><link linkend="_widget_8h_1a86794ff6578c24e8b16b94bf853dd2b3">widget_get_graph_view_control()</link> </para>
<para><link linkend="_widget_8h_1ab37220d257ccf0ac8a2f4b0f41b83ab9">widget_get_space_view()</link> </para>
<para><link linkend="_widget_8h_1affbfa87fb5a08853b9a4d92de8877ff7">widget_get_space_edit_control()</link> </para>
<para><link linkend="_widget_8h_1a593c9c15eb7c193c589dac7c28c36560">widget_get_sequence_control()</link> </para>
<para><link linkend="_fsm_2dispatch_8c_1a9123915ffd10fe1ae18254898b1c0ebf">fsm_get_exec_edit()</link> </para>
<para><link linkend="_widget_8h_1aeee38e575fcf6ddcee8b1cc597ff555c">PARTITION_SPACE_VS_CAMERA_IN_STATE</link> </para>
<para><link linkend="_widget_8h_1a9c680cde49123bd06aff94a246dfdd77">PARTITION_SPACE_VS_CONTROLS_1</link> </para>
<para><link linkend="_widget_8h_1ac4959aea231be3980763d41e10e4b04a">PARTITION_SPACE_VS_CONTROLS_2</link></para>
<para><link linkend="_signal_8h_1aab85638be623932944de0247e4a5e50e">on_switch_state_rules_data()</link></para>
</formalpara>
<formalpara><title>Returns</title>
<para>view_space_vs_controls </para>
</formalpara>
</para>
</section>
</section>
</section>

34
doc/rtfm/Once upon a time, Normal file
View File

@ -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.

12
doc/rtfm/man3/Stack.3
View File

@ -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

1
doc/rtfm/man3/WANT_TO_START_ON_ANOTHER_PAGE.3 Normal file
View File

@ -0,0 +1 @@
.so man3/left.c.3

1
doc/rtfm/man3/WANT_TO_START_ON_ANOTHER_PAGE_.3 Normal file
View File

@ -0,0 +1 @@
.so man3/left.c.3

5
doc/rtfm/man3/assign.c.3
View File

@ -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

22
doc/rtfm/man3/bottom.c.3
View File

@ -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\&.

12
doc/rtfm/man3/camera.c.3
View File

@ -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\&.

16
doc/rtfm/man3/center.c.3
View File

@ -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\&.

5
doc/rtfm/man3/conditions.c.3
View File

@ -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

8
doc/rtfm/man3/data_list.c.3
View File

@ -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

10
doc/rtfm/man3/designer.c.3
View File

@ -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"

3
doc/rtfm/man3/dialog.c.3
View File

@ -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

12
doc/rtfm/man3/disp_list.c.3
View File

@ -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

22
doc/rtfm/man3/display.c.3
View File

@ -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\&.

12
doc/rtfm/man3/edit.c.3
View File

@ -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\&.

12
doc/rtfm/man3/freq.c.3
View File

@ -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\&.

6
doc/rtfm/man3/fsm.h.3
View File

@ -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"

12
doc/rtfm/man3/geometry.c.3
View File

@ -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\&.

3
doc/rtfm/man3/identity.c.3
View File

@ -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\&.

13
doc/rtfm/man3/interest.c.3
View File

@ -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\&.

12
doc/rtfm/man3/investigate.c.3
View File

@ -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\&.

5
doc/rtfm/man3/labo.c.3
View File

@ -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\&.

58
doc/rtfm/man3/left.c.3
View File

@ -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,40 +30,76 @@ 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
.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\&.

9
doc/rtfm/man3/manager.c.3
View File

@ -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

8
doc/rtfm/man3/middle.c.3
View File

@ -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\&.

11
doc/rtfm/man3/modal.c.3
View File

@ -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

1
doc/rtfm/man3/on_switch_state_rules_data.3 Normal file
View File

@ -0,0 +1 @@
.so man3/signal.h.3

12
doc/rtfm/man3/organize.c.3
View File

@ -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\&.

22
doc/rtfm/man3/pilot_box.c.3
View File

@ -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\&.

43
doc/rtfm/man3/signal.c.3
View File

@ -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

43
doc/rtfm/man3/signal.h.3
View File

@ -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

12
doc/rtfm/man3/time.c.3
View File

@ -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\&.

10
doc/rtfm/man3/top.c.3
View File

@ -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

3
doc/rtfm/man3/utilities.c.3
View File

@ -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,8 +47,6 @@ 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\&.
.PP
\fBSince\fP

577
doc/rtfm/man3/widget.h.3
View File

@ -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
@ -601,11 +790,16 @@ src/widget/one_rule/algebra/identity()
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,9 +1039,146 @@ 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
\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
@ -828,9 +1230,16 @@ 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
\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\&.

1
doc/rtfm/man3/widget_get_selected_rule_assignments_list_btt.3 Normal file
View File

@ -0,0 +1 @@
.so man3/widget.h.3

6
include/fsm.h
View File

@ -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,
};

1
include/signal.h
View File

@ -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();

2
include/widget.h
View File

@ -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 */

14
src/fsm/measures/data_list.c
View File

@ -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

28
src/fsm/measures/disp_list.c
View File

@ -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

41
src/signal.c
View File

@ -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()", "");
}
}

2
src/widget/dialog.c
View File

@ -36,8 +36,6 @@
/******************************************************************************/
/**
* modal
*
* @callgraph
* @see src/fsm/dispatch/fsm_journal_event()
*

4
src/widget/main_window/all_rules/compare/interest.c
View File

@ -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(){

2
src/widget/main_window/all_rules/dispatch.c
View File

@ -58,7 +58,7 @@
/**
* phantom documentation
* @returns rules_tree_and_pilot_box
*/
void *widget_get_pane_all_rules_left ()
{

2
src/widget/main_window/all_rules/tree/freq.c
View File

@ -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 ()
{

2
src/widget/main_window/all_rules/tree/labo.c
View File

@ -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);

7
src/widget/main_window/all_rules/tree/pilot_box.c
View File

@ -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 ()
{

7
src/widget/main_window/designer.c
View File

@ -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 <contact@a-lec.org>

32
src/widget/main_window/measure/dispatch.c
View File

@ -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()
{

4
src/widget/main_window/one_rule/algebra/assign.c
View File

@ -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 - - - - - - - - - - - - - - - >

4
src/widget/main_window/one_rule/algebra/conditions.c
View File

@ -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

6
src/widget/main_window/one_rule/algebra/dispatch.c
View File

@ -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()
{

3
src/widget/main_window/one_rule/algebra/identity.c
View File

@ -32,11 +32,10 @@
#include <stdlib.h>
/**
* @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.

2
src/widget/main_window/one_rule/algebra/utilities.c
View File

@ -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
*

10
src/widget/main_window/one_rule/dispatch.c
View File

@ -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()

2
src/widget/main_window/one_rule/geometry/camera.c
View File

@ -70,7 +70,7 @@ static GtkBox *rec_ZOOM_box()
}
/**
* Phantom documentation
* @returns camera
*/
void *widget_get_selected_rule_camera()
{

9
src/widget/main_window/one_rule/geometry/dispatch.c
View File

@ -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()
{

2
src/widget/main_window/one_rule/geometry/edit.c
View File

@ -31,7 +31,7 @@
/**
* Phantom documentation
* @returns gtk_label_new ("RULE EDITION")
*/
void *widget_get_rule_edition_tools()
{

2
src/widget/main_window/one_rule/geometry/geometry.c
View File

@ -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()
{

Some files were not shown because too many files have changed in this diff Show More