1164 lines
52 KiB
XML
1164 lines
52 KiB
XML
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
|
|
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_widget_8h" xml:lang="en-US">
|
|
<title>include/widget.h File Reference</title>
|
|
<indexterm><primary>include/widget.h</primary></indexterm>
|
|
<para>
|
|
|
|
<para>widgets hierarchy header </para>
|
|
|
|
</para>
|
|
<programlisting linenumbering="unnumbered">#include <gtk-4.0/gtk/gtk.h><?linebreak?></programlisting><simplesect>
|
|
<title>Classes </title>
|
|
<itemizedlist>
|
|
<listitem><para>struct <link linkend="_structTreeNode__t">TreeNode_t</link></para>
|
|
|
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>Macros </title>
|
|
<itemizedlist>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a0817a25a70e19c1d1aaaa97ee4c88d0c"/>#define <emphasis role="strong">W_MY_SCREEN</emphasis>   1920</para>
|
|
|
|
<para>1920 x 960 = ad hoc (pour mon écran)) </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1ac12c2e57b99c1d88005b4bc9142d123f"/>#define <emphasis role="strong">H_MY_SCREEN</emphasis>   1000</para>
|
|
|
|
<para>Full HD (1920 x 1080 pixels) </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1aac1fd67e09f1d17b32f87924e66681e5"/>#define <emphasis role="strong">W_TEXT_WINDOW</emphasis>   550</para>
|
|
|
|
<para>ad hoc (mais sans conséquences ici) </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a1ec985cbecdb9a4ecfe426fd69261afc"/>#define <emphasis role="strong">H_TEXT_WINDOW</emphasis>   <link linkend="_widget_8h_1ac12c2e57b99c1d88005b4bc9142d123f">H_MY_SCREEN</link></para>
|
|
|
|
<para>== </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a0cf886c72c500353c5428b167b6cfd33"/>#define <emphasis role="strong">W_TREE</emphasis>   160</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a077f1f93ecea419f349b573f8a845af1"/>#define <emphasis role="strong">W_DO_UNDO_REDO_BOX</emphasis>   1300</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a526b392f8da7015c7bae203e86562241"/>#define <emphasis role="strong">W_XYZ_BOX</emphasis>   62</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a8387ddddc78874c390241019cfbaa28a"/>#define <emphasis role="strong">H_XYZ_BOX</emphasis>   200</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1ae91d0e051eb50649ae3c849632dbc258"/>#define <emphasis role="strong">H_E_COLI</emphasis>   760</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a084cf746d1dd8b0d987828574671a20d"/>#define <emphasis role="strong">H_OBJECTS_SITUATIONS</emphasis>   130</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a335ac975697e8a28f32a0563bad79324"/>#define <emphasis role="strong">W_COMPARATOR</emphasis>   64</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a3b010ae47c116cd97010bf2d13725fbd"/>#define <emphasis role="strong">W_RULES_USE</emphasis>   90</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1aa5ed481c549efbbf9839860010aed08d"/>#define <emphasis role="strong">W_IMAGE_800</emphasis>   800</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a080ac7f1ee88912c97e282e4d1456645"/>#define <emphasis role="strong">W_IMAGE_100</emphasis>   100</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a377686eeea60d44a455d2e9e65dc6885"/>#define <emphasis role="strong">ALL_VS_SELECTED</emphasis>   340</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1af33e64cc89411c86e53ae5077e0778d7"/>#define <emphasis role="strong">H_PARTITION_SYNTH</emphasis>   1600</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1ae075d12023480ed8aa2e87e3618823ec"/>#define <emphasis role="strong">W_PARTITION_SYNTH</emphasis>   400</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1acdc80ea2d22b230743a04959ddaec5a1"/>#define <emphasis role="strong">PARTITION_STATE_TOP</emphasis>   600</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a9c680cde49123bd06aff94a246dfdd77"/>#define <emphasis role="strong">PARTITION_SPACE_VS_CONTROLS_1</emphasis>   920</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1ac4959aea231be3980763d41e10e4b04a"/>#define <emphasis role="strong">PARTITION_SPACE_VS_CONTROLS_2</emphasis>   800</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1aeee38e575fcf6ddcee8b1cc597ff555c"/>#define <emphasis role="strong">PARTITION_SPACE_VS_CAMERA_IN_STATE</emphasis>   1850</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a6efea6accef9965b198cb46ca7bad3a9"/>#define <emphasis role="strong">PARTITION_SPACE_VS_CAMERA_IN_SYNTH</emphasis>   1560</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1aa2b371a8e41e74cbecb17b8ee36bd9a0"/>#define <emphasis role="strong">LIST_W</emphasis>   190</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1af6381825ddcaef499d49dc4bd06aa4d3"/>#define <emphasis role="strong">LIST_H</emphasis>   114</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1adc9e877ab16c1477603950032e4f99c7"/>#define <emphasis role="strong">H_PARTITION_RESULTS</emphasis>   140</para>
|
|
|
|
<para>arbitrary </para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>Functions </title>
|
|
<itemizedlist>
|
|
<listitem><para>GtkWindow * <link linkend="_widget_8h_1aa79c2ff4883932d6f9b7184d1d05dd5d">widget_get_main_window</link> ()</para>
|
|
|
|
<para>getter </para>
|
|
</listitem>
|
|
<listitem><para>GtkWindow * <link linkend="_widget_8h_1a8a3fc181cce5aa9cfb0623abf0315f5d">widget_get_dialog_window</link> ()</para>
|
|
|
|
<para>getter </para>
|
|
</listitem>
|
|
<listitem><para>GtkWindow * <link linkend="_widget_8h_1a84dce957680294b8b928c5bc9b2c1dfb">widget_get_text_window</link> ()</para>
|
|
|
|
<para>getter </para>
|
|
</listitem>
|
|
<listitem><para>void <link linkend="_widget_8h_1a6458bdae6bcf9131bc7c793810869db7">widget_design_main_window</link> (GtkWindow *main_window, GtkApplication *app)</para>
|
|
</listitem>
|
|
<listitem><para>void <link linkend="_widget_8h_1a1591b0ceef41a3926eee69905735b3ec">widget_design_dialog_window</link> (GtkWindow *main_window, GtkWindow *dialog_window)</para>
|
|
|
|
<para>modal </para>
|
|
</listitem>
|
|
<listitem><para>void <link linkend="_widget_8h_1a2de49d7ea886ac83d68af532046c0868">widget_design_text_window</link> (GtkWindow *main_window, GtkWindow *text_window)</para>
|
|
|
|
<para>modal </para>
|
|
</listitem>
|
|
<listitem><para>const char * <link linkend="_widget_8h_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="_widget_8h_1a22ed4aed09c29d9f8c72dbe7ced53e2c"/>const char * <emphasis role="strong">widget_get_btt_label_state</emphasis> ()</para>
|
|
|
|
<para>btt_state </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1adea9b5591d51aab274d8c275045d778c"/>const char * <emphasis role="strong">widget_get_btt_label_rules</emphasis> ()</para>
|
|
|
|
<para>btt_rules </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a136322baea0729a8dfbc5c9b1bc0667e"/>const char * <emphasis role="strong">widget_get_btt_label_data</emphasis> ()</para>
|
|
|
|
<para>btt_data <?linebreak?> </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a149992300a77b245016ed0e1984651d4"/>void <emphasis role="strong">window_design_topbar_center</emphasis> (GtkWidget *topbar)</para>
|
|
|
|
<para>title </para>
|
|
</listitem>
|
|
<listitem><para>void <link linkend="_widget_8h_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>
|
|
<listitem><para>void <link linkend="_widget_8h_1a4a9ccdb6dc6dbc18f1e2d2235fbb26c3">window_design_topbar_right</link> (GtkWidget *header_bar, GtkApplication *app)</para>
|
|
</listitem>
|
|
<listitem><para>GtkWidget * <link linkend="_widget_8h_1ad937c2a7a1f8a2af174434bd5f1dcf20">widget_get_topbar</link> (GtkApplication *app)</para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a990f88f46feba957a864d7bf203f42e7"/>void * <emphasis role="strong">widget_get_page_synth</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a9689934ad6d7c98379f35d49adf11878"/>void * <emphasis role="strong">widget_get_page_state</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a56cdc1609820a67a52fb095ba0128d3f"/>void * <emphasis role="strong">widget_get_page_data</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1afabb3345620886cdee4f2b76c9d84a51"/>void * <emphasis role="strong">widget_get_page_measure</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1aff18a7cea4191d9ae0480f2eaca06a5f"/>void * <emphasis role="strong">widget_get_time_dependent</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1aed9b242acda234a0ca5cd359cb6d29e2"/>void * <emphasis role="strong">widget_get_space_vs_non_time_dependent</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1abc35a23e7853e1e3628b389291f29cba"/>void * <emphasis role="strong">widget_get_non_time_dependent</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para>void * <link linkend="_widget_8h_1ab37220d257ccf0ac8a2f4b0f41b83ab9">widget_get_space_view</link> (int partition_space_vs_camera)</para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a86794ff6578c24e8b16b94bf853dd2b3"/>void * <emphasis role="strong">widget_get_graph_view_control</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1affbfa87fb5a08853b9a4d92de8877ff7"/>void * <emphasis role="strong">widget_get_space_edit_control</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a593c9c15eb7c193c589dac7c28c36560"/>void * <emphasis role="strong">widget_get_sequence_control</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para>void <link linkend="_widget_8h_1a4081353ac1420fa15533a11bcbff3238">widget_set_situations_value</link> (int value)</para>
|
|
</listitem>
|
|
<listitem><para>void <link linkend="_widget_8h_1affefa1ca48e64b5b440729fecbe0e4ee">widget_set_objects_value</link> (int rank, int value)</para>
|
|
</listitem>
|
|
<listitem><para>int <link linkend="_widget_8h_1a1b7d49db6b4e22a55da588d1137b6e2c">widget_get_object_transparency</link> (int i)</para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a8019caa45a82a3d92061d49818d0f617"/>void <emphasis role="strong">widget_reset_XYZ_in_state_pane</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a1c074a5748ee5c7e9974bb75539adb34"/>void * <emphasis role="strong">widget_get_pane_all_rules_left</emphasis> ()</para>
|
|
|
|
<para>phantom documentation </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1ab9db55b708939397362a8a11489c64c5"/>void * <emphasis role="strong">widget_get_pane_selected_rule_right</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a192412673ea82a53a66fd809a5b1fd55"/>void * <emphasis role="strong">widget_get_rules_pilot_box</emphasis> ()</para>
|
|
|
|
<para>phantom documentation </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a3cecbcc7340289ed318347f1bf86308c"/>void * <emphasis role="strong">widget_get_rules_tree_tools</emphasis> ()</para>
|
|
|
|
<para>phantom documentation </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a1f62040452052165b13a8e9bf23ab368"/>void * <emphasis role="strong">widget_get_rules_use</emphasis> ()</para>
|
|
|
|
<para>phantom documentation </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1ab6a3b9836a4c333b59b34cb97d00df3a"/>void * <emphasis role="strong">widget_get_selected_rule</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a8b314bd2dcf59006649ff86ae04e9eaf"/>void * <emphasis role="strong">widget_get_rule_edition_tools</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a4d4d650591869cebc663884c29c6bb7c"/>void * <emphasis role="strong">widget_get_rule_investigation_tools</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para>void * <link linkend="_widget_8h_1a15cbd8402e76ff0dd5e6b39e17a9dc49">widget_get_selected_rule_algebra</link> ()</para>
|
|
|
|
<para>Provides the three lists needed to describe a rule algebraically. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a303a3e0838137d31f4e04a416ebf6310"/>void * <emphasis role="strong">widget_get_selected_rule_geometry</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para>void * <link linkend="_widget_8h_1a8d42128cf54da36d55112fa5f5634f96">widget_get_selected_rule_conditions_list_btt</link> ()</para>
|
|
|
|
<para>Builds and presents the conditions list of a rule. </para>
|
|
</listitem>
|
|
<listitem><para>void * <link linkend="_widget_8h_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>
|
|
<listitem><para>void * <link linkend="_widget_8h_1afcfab13d3504a69ec5f4ae6ad6974e29">widget_get_selected_rule_identity_btt</link> ()</para>
|
|
|
|
<para>Hosts a list of character strings that can be combined to provide a "human readable" rule identifier. </para>
|
|
</listitem>
|
|
<listitem><para>GtkEntry <link linkend="_widget_8h_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>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a1b97f8be0394a44033a491d7bb44dce2"/>void * <emphasis role="strong">widget_get_selected_rule_camera</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a075009e3b1816abfd76bd3d4fcdda890"/>void * <emphasis role="strong">widget_get_selected_rule_before_after</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1aba1af8256174f6a4661675d2b3c6c34d"/>void * <emphasis role="strong">widget_get_results_box_organize</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1aeca06e5a8c669b8d8f9dd82289f4e1e1"/>void * <emphasis role="strong">widget_get_results_box_display</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a1cc6f65cd162b7c49e760ab29e8b7919"/>void * <emphasis role="strong">widget_get_results_box_time</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para>struct <link linkend="_structTreeNode__t">TreeNode_t</link> * <link linkend="_widget_8h_1a82852f17d5f914c6cfb35b892766ab1e">widget_create_user_rules_tree_node</link> (const gchar *text)</para>
|
|
</listitem>
|
|
<listitem><para>void <link linkend="_widget_8h_1a95c04d702f36a7422a9e14eaf456ed3e">widget_add_tree_child_node</link> (struct <link linkend="_structTreeNode__t">TreeNode_t</link> *parent, struct <link linkend="_structTreeNode__t">TreeNode_t</link> *child)</para>
|
|
</listitem>
|
|
<listitem><para>void * <link linkend="_widget_8h_1af968daedf9ce1bd06c674c69ef793201">widget_get_user_rules_tree</link> ()</para>
|
|
</listitem>
|
|
<listitem><para>void * <link linkend="_widget_8h_1a5592a550ad1f66ae7092b580318878f8">widget_get_text_from_address</link> (gchar *text_name)</para>
|
|
|
|
<para>getter </para>
|
|
</listitem>
|
|
<listitem><para>char * <link linkend="_widget_8h_1aee7518cfd4073577afedafc70705e233">widget_get_address_text_theory</link> ()</para>
|
|
</listitem>
|
|
<listitem><para>char * <link linkend="_widget_8h_1acfad36e48f845c075056fb8fbe765c0e">widget_get_address_text_practice</link> ()</para>
|
|
</listitem>
|
|
<listitem><para>char * <link linkend="_widget_8h_1a905ee0e77908c113609224ee28aaa0ee">widget_get_address_text_alpha_index</link> ()</para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a60d9aed440437cd898f609784c32b2f5"/>void * <emphasis role="strong">widget_get_an_impression_of_what_a_rules_comparator_could_be</emphasis> ()</para>
|
|
|
|
<para>phantom documentation </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_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>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a27574b02d486a2e93ed1a3e0f6461798"/>void * <emphasis role="strong">widget_measure_new</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a88886ed08e68539a9c5280fc40c2c2a0"/>void * <emphasis role="strong">widget_measure_do_select_rules_first</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1aea7a46578d6e1f0a2ee58b0f6eb16028"/>void * <emphasis role="strong">widget_measure_do_depends_on_one_or_two_events</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a5b3aeea035afbf3cb35744687f091b1b"/>void * <emphasis role="strong">widget_measure_do_depends_on_a_single_event</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a7c86507328bb9c31a0dcc0c97cf66c25"/>void * <emphasis role="strong">widget_measure_do_depends_on_two_events</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a444bf6c3230e0f97827eda74818ba258"/>void * <emphasis role="strong">widget_measure_do_select_a_second_rules_set</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a37872533aa0116818c810d9cdad7f4ed"/>void * <emphasis role="strong">widget_measure_do_choose_an_event_type</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1aaab2ef1ae64c85052ab65ed684f3a132"/>void * <emphasis role="strong">widget_measure_do_correlate</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a3d1ceccb1f00d0a2f3329af8b499844b"/>void * <emphasis role="strong">widget_measure_do_insert_in_measurements_list</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a5f9f287e97e9bdad13662a864a1d5273"/>void * <emphasis role="strong">widget_measure_do_end_creation_of_measurement_process</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a0cef6d510a6777d25e26ec5900c38239"/>void * <emphasis role="strong">widget_measure_event_occurences_nb</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a3fae10bb44f33d896f72352df671be61"/>void * <emphasis role="strong">widget_measure_event_occurences_dates</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a58049a1f53bb6e189b5a60004fd716b5"/>void * <emphasis role="strong">widget_measure_event_occurences_situations</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a42113abbf8118a8362314d2427f540dc"/>void * <emphasis role="strong">widget_measure_time_elapsed_between_two_events</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
<listitem><para><anchor xml:id="_widget_8h_1a05bd4127a0e218921c87eb499595f860"/>void * <emphasis role="strong">widget_measure_third_event_occurences_in_between</emphasis> ()</para>
|
|
|
|
<para>Phantom documentation. </para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</simplesect>
|
|
<section>
|
|
<title>Detailed Description</title>
|
|
|
|
<para>widgets hierarchy header </para>
|
|
|
|
<para>This file is part of Gem-graph. </para>
|
|
</section>
|
|
<section>
|
|
<title>Function Documentation</title>
|
|
<anchor xml:id="_widget_8h_1a95c04d702f36a7422a9e14eaf456ed3e"/><section>
|
|
<title>widget_add_tree_child_node()</title>
|
|
<indexterm><primary>widget_add_tree_child_node</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</primary><secondary>widget_add_tree_child_node</secondary></indexterm>
|
|
<para><computeroutput>void widget_add_tree_child_node (struct <link linkend="_structTreeNode__t">TreeNode_t</link> * parent, struct <link linkend="_structTreeNode__t">TreeNode_t</link> * child)</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>*parent</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>*child</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1a82852f17d5f914c6cfb35b892766ab1e"/><section>
|
|
<title>widget_create_user_rules_tree_node()</title>
|
|
<indexterm><primary>widget_create_user_rules_tree_node</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</primary><secondary>widget_create_user_rules_tree_node</secondary></indexterm>
|
|
<para><computeroutput>struct <link linkend="_structTreeNode__t">TreeNode_t</link> * widget_create_user_rules_tree_node (const gchar * text)</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>*text</entry><entry></entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
<formalpara><title>Returns</title>
|
|
|
|
<para><link linkend="_structTreeNode__t">TreeNode_t</link> </para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1a1591b0ceef41a3926eee69905735b3ec"/><section>
|
|
<title>widget_design_dialog_window()</title>
|
|
<indexterm><primary>widget_design_dialog_window</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</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><formalpara><title>See also</title>
|
|
|
|
<para>src/fsm/dispatch/fsm_journal_event()</para>
|
|
|
|
<para>src/widget/manager/on_windows_activation()</para>
|
|
</formalpara>
|
|
|
|
<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>*main_window</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>*dialog_window</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1a6458bdae6bcf9131bc7c793810869db7"/><section>
|
|
<title>widget_design_main_window()</title>
|
|
<indexterm><primary>widget_design_main_window</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</primary><secondary>widget_design_main_window</secondary></indexterm>
|
|
<para><computeroutput>void widget_design_main_window (GtkWindow * main_window, GtkApplication * app)</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>*main_window</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>*app</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1a2de49d7ea886ac83d68af532046c0868"/><section>
|
|
<title>widget_design_text_window()</title>
|
|
<indexterm><primary>widget_design_text_window</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</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><formalpara><title>See also</title>
|
|
|
|
<para>src/widget/modal/widget_get_text_from_address()</para>
|
|
|
|
<para>src/widget/manager/on_windows_activation()</para>
|
|
</formalpara>
|
|
|
|
<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>*main_window</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>*text_window</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1a905ee0e77908c113609224ee28aaa0ee"/><section>
|
|
<title>widget_get_address_text_alpha_index()</title>
|
|
<indexterm><primary>widget_get_address_text_alpha_index</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</primary><secondary>widget_get_address_text_alpha_index</secondary></indexterm>
|
|
<para><computeroutput>char * widget_get_address_text_alpha_index ( )</computeroutput></para>
|
|
<para><formalpara><title>Returns</title>
|
|
|
|
<para>"./alphabetic_index.all" </para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1acfad36e48f845c075056fb8fbe765c0e"/><section>
|
|
<title>widget_get_address_text_practice()</title>
|
|
<indexterm><primary>widget_get_address_text_practice</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</primary><secondary>widget_get_address_text_practice</secondary></indexterm>
|
|
<para><computeroutput>char * widget_get_address_text_practice ( )</computeroutput></para>
|
|
<para><formalpara><title>Returns</title>
|
|
|
|
<para>"./data/text/pratique.txt" </para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1aee7518cfd4073577afedafc70705e233"/><section>
|
|
<title>widget_get_address_text_theory()</title>
|
|
<indexterm><primary>widget_get_address_text_theory</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</primary><secondary>widget_get_address_text_theory</secondary></indexterm>
|
|
<para><computeroutput>char * widget_get_address_text_theory ( )</computeroutput></para>
|
|
<para><formalpara><title>Returns</title>
|
|
|
|
<para>"./data/text/théorie.txt" </para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1a3d0f8c7b9545a6da3464060dad7990db"/><section>
|
|
<title>widget_get_btt_label_synth()</title>
|
|
<indexterm><primary>widget_get_btt_label_synth</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</primary><secondary>widget_get_btt_label_synth</secondary></indexterm>
|
|
<para><computeroutput>const char * widget_get_btt_label_synth ( )</computeroutput></para><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>
|
|
</para>
|
|
|
|
<para>btt_synth </para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1a8a3fc181cce5aa9cfb0623abf0315f5d"/><section>
|
|
<title>widget_get_dialog_window()</title>
|
|
<indexterm><primary>widget_get_dialog_window</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</primary><secondary>widget_get_dialog_window</secondary></indexterm>
|
|
<para><computeroutput>GtkWindow * widget_get_dialog_window ( )</computeroutput></para><para>
|
|
|
|
<para>getter </para>
|
|
</para>
|
|
|
|
<para><formalpara><title>Since</title>
|
|
|
|
<para>2024-07</para>
|
|
</formalpara>
|
|
<formalpara><title>See also</title>
|
|
|
|
<para>src/signal </para>
|
|
</formalpara>
|
|
<formalpara><title>Returns</title>
|
|
|
|
<para>dialog_window </para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1aa79c2ff4883932d6f9b7184d1d05dd5d"/><section>
|
|
<title>widget_get_main_window()</title>
|
|
<indexterm><primary>widget_get_main_window</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</primary><secondary>widget_get_main_window</secondary></indexterm>
|
|
<para><computeroutput>GtkWindow * widget_get_main_window ( )</computeroutput></para><para>
|
|
|
|
<para>getter </para>
|
|
</para>
|
|
|
|
<para><formalpara><title>Since</title>
|
|
|
|
<para>2024-07</para>
|
|
</formalpara>
|
|
<formalpara><title>See also</title>
|
|
|
|
<para>src/signal </para>
|
|
</formalpara>
|
|
<formalpara><title>Returns</title>
|
|
|
|
<para>main_window </para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1a1b7d49db6b4e22a55da588d1137b6e2c"/><section>
|
|
<title>widget_get_object_transparency()</title>
|
|
<indexterm><primary>widget_get_object_transparency</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</primary><secondary>widget_get_object_transparency</secondary></indexterm>
|
|
<para><computeroutput>int widget_get_object_transparency (int rank)</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>rank</entry><entry></entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
<formalpara><title>Returns</title>
|
|
|
|
<para>value </para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1a15cbd8402e76ff0dd5e6b39e17a9dc49"/><section>
|
|
<title>widget_get_selected_rule_algebra()</title>
|
|
<indexterm><primary>widget_get_selected_rule_algebra</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</primary><secondary>widget_get_selected_rule_algebra</secondary></indexterm>
|
|
<para><computeroutput>void * widget_get_selected_rule_algebra ( )</computeroutput></para><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>
|
|
<para>conditions</para>
|
|
</listitem><listitem>
|
|
<para>assignations</para>
|
|
</listitem><listitem>
|
|
<para>name (a set of identity elements)</para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
|
|
<para><formalpara><title>Since</title>
|
|
|
|
<para>2024-08</para>
|
|
</formalpara>
|
|
<formalpara><title>See also</title>
|
|
|
|
<para>src/widget/one_rule/algebra/conditions() </para>
|
|
|
|
<para>src/widget/one_rule/algebra/assignations() </para>
|
|
|
|
<para>src/widget/one_rule/algebra/identity()</para>
|
|
|
|
<para>src/widget/one_rule/dispatch() </para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1a9020593f4cd1b7f9dd85dd383523474c"/><section>
|
|
<title>widget_get_selected_rule_assignments_list_btt()</title>
|
|
<indexterm><primary>widget_get_selected_rule_assignments_list_btt</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</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>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>
|
|
|
|
<para>|- - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - - ></para>
|
|
|
|
<para>This list groups all the elementary assignments of the rule. No assignment should be repeated or modified by other assignments. (== a unique assignment per address in rule workspace) Completeness is not required. (== there does not need to be one assignment per address in the rule workspace)</para>
|
|
|
|
<para>< - - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - -|</para>
|
|
|
|
<para><formalpara><title>Since</title>
|
|
|
|
<para>2024-08</para>
|
|
</formalpara>
|
|
<formalpara><title>See also</title>
|
|
|
|
<para>src/widget/one_rule/algebra/utilities/widget_set_item_text() </para>
|
|
|
|
<para>src/fsm/dispatch/fsm_journal_event() < TODO (for each item ?)</para>
|
|
|
|
<para>src/widget/one_rule/algebra/dispatch()</para>
|
|
</formalpara>
|
|
<formalpara><title>Returns</title>
|
|
|
|
<para>the assignations list </para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1a8d42128cf54da36d55112fa5f5634f96"/><section>
|
|
<title>widget_get_selected_rule_conditions_list_btt()</title>
|
|
<indexterm><primary>widget_get_selected_rule_conditions_list_btt</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</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>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>
|
|
|
|
<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>
|
|
|
|
<para>|- - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - - ></para>
|
|
|
|
<para>No conditions should be repeated. No condition may contradict another (== a unique condition per address in rule workspace) Completeness is not required (== there does not need to be one condition per address in the rule workspace)</para>
|
|
|
|
<para>(NB The following applies to server workers) Two rules cannot share the same set of conditions. If several rules apply to the same set of local conditions - which can happen if several different actions are possible from the same situation - they must each include an additional condition determining their probability of execution in the event of a conflict. If two rules share the same local set of conditions, they must both be evaluated. If all the conditions of one rule are included in the conditions of another rule, then the other rule must be evaluated first.</para>
|
|
|
|
<para>< - - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - -|</para>
|
|
|
|
<para><formalpara><title>Since</title>
|
|
|
|
<para>2024-08</para>
|
|
</formalpara>
|
|
<formalpara><title>See also</title>
|
|
|
|
<para>src/widget/one_rule/algebra/utilities/widget_set_item_text() </para>
|
|
|
|
<para>src/fsm/dispatch/fsm_journal_event() < TODO (for each item ?)</para>
|
|
|
|
<para>src/widget/one_rule/algebra/dispatch()</para>
|
|
</formalpara>
|
|
<formalpara><title>Returns</title>
|
|
|
|
<para>the conditions list </para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1afcfab13d3504a69ec5f4ae6ad6974e29"/><section>
|
|
<title>widget_get_selected_rule_identity_btt()</title>
|
|
<indexterm><primary>widget_get_selected_rule_identity_btt</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</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 "human readable" rule identifier. </para>
|
|
</para>
|
|
|
|
<para>This list can also contain non-mandatory elements.</para>
|
|
|
|
<para>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.</para>
|
|
|
|
<para>On the contrary, for the automaton, the identity of each rule is given exclusively by its set of conditions.</para>
|
|
|
|
<para>Today, this function provides only an arbitrary presentation with no link to the XML model and no verification of compliance with the meta-rules. (see below) TODO</para>
|
|
|
|
<para>|- - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - - ></para>
|
|
|
|
<para>No item of the list should be repeated. No element describing the function of the rule can contradict another. All the elements required for identification by name must be present. Uniqueness is required (This name must be usable as a key). Non-mandatory elements can be added (comments, etc.).</para>
|
|
|
|
<para>< - - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - -|</para>
|
|
|
|
<para><formalpara><title>Since</title>
|
|
|
|
<para>2024-08</para>
|
|
</formalpara>
|
|
<formalpara><title>See also</title>
|
|
|
|
<para>src/widget/one_rule/algebra/utilities/widget_set_item_text() </para>
|
|
|
|
<para>src/fsm/dispatch/fsm_journal_event() < TODO (for each item ?)</para>
|
|
|
|
<para>src/widget/one_rule/algebra/dispatch/gtk_box_append()</para>
|
|
</formalpara>
|
|
<formalpara><title>Returns</title>
|
|
|
|
<para>rule identity </para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1ab37220d257ccf0ac8a2f4b0f41b83ab9"/><section>
|
|
<title>widget_get_space_view()</title>
|
|
<indexterm><primary>widget_get_space_view</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</primary><secondary>widget_get_space_view</secondary></indexterm>
|
|
<para><computeroutput>void * widget_get_space_view (int partition_space_vs_camera)</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>partition_space_vs_camera</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1a5592a550ad1f66ae7092b580318878f8"/><section>
|
|
<title>widget_get_text_from_address()</title>
|
|
<indexterm><primary>widget_get_text_from_address</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</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><formalpara><title>See also</title>
|
|
|
|
<para>src/widget/modal/widget_design_text_window()</para>
|
|
</formalpara>
|
|
|
|
<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>*text_address</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1a84dce957680294b8b928c5bc9b2c1dfb"/><section>
|
|
<title>widget_get_text_window()</title>
|
|
<indexterm><primary>widget_get_text_window</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</primary><secondary>widget_get_text_window</secondary></indexterm>
|
|
<para><computeroutput>GtkWindow * widget_get_text_window ( )</computeroutput></para><para>
|
|
|
|
<para>getter </para>
|
|
</para>
|
|
|
|
<para><formalpara><title>Since</title>
|
|
|
|
<para>2024-07</para>
|
|
</formalpara>
|
|
<formalpara><title>See also</title>
|
|
|
|
<para>src/signal </para>
|
|
</formalpara>
|
|
<formalpara><title>Returns</title>
|
|
|
|
<para>text_window </para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1ad937c2a7a1f8a2af174434bd5f1dcf20"/><section>
|
|
<title>widget_get_topbar()</title>
|
|
<indexterm><primary>widget_get_topbar</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</primary><secondary>widget_get_topbar</secondary></indexterm>
|
|
<para><computeroutput>GtkWidget * widget_get_topbar (GtkApplication * app)</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>*app</entry><entry></entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
<formalpara><title>Returns</title>
|
|
|
|
<para>topbar </para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1af968daedf9ce1bd06c674c69ef793201"/><section>
|
|
<title>widget_get_user_rules_tree()</title>
|
|
<indexterm><primary>widget_get_user_rules_tree</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</primary><secondary>widget_get_user_rules_tree</secondary></indexterm>
|
|
<para><computeroutput>void * widget_get_user_rules_tree ( )</computeroutput></para>
|
|
<para><formalpara><title>Returns</title>
|
|
|
|
<para>scrolled_window </para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1a1c4f1ce489cdc3b4e5a1e86d3438e846"/><section>
|
|
<title>widget_set_item_text()</title>
|
|
<indexterm><primary>widget_set_item_text</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</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>Format an entry (a text item) in a list. </para>
|
|
</para>
|
|
|
|
<para><formalpara><title>Since</title>
|
|
|
|
<para>2024-08</para>
|
|
</formalpara>
|
|
<formalpara><title>See also</title>
|
|
|
|
<para>src/widget/one_rule/algebra/conditions() </para>
|
|
|
|
<para>src/widget/one_rule/algebra/assign() </para>
|
|
|
|
<para>src/widget/one_rule/algebra/identity()</para>
|
|
</formalpara>
|
|
|
|
<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>*list_box</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>*text</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>editable</entry><entry></entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
<formalpara><title>Returns</title>
|
|
|
|
<para>*entry < a text item </para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1affefa1ca48e64b5b440729fecbe0e4ee"/><section>
|
|
<title>widget_set_objects_value()</title>
|
|
<indexterm><primary>widget_set_objects_value</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</primary><secondary>widget_set_objects_value</secondary></indexterm>
|
|
<para><computeroutput>void widget_set_objects_value (int rank, int value)</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>rank</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>value</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1a4081353ac1420fa15533a11bcbff3238"/><section>
|
|
<title>widget_set_situations_value()</title>
|
|
<indexterm><primary>widget_set_situations_value</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</primary><secondary>widget_set_situations_value</secondary></indexterm>
|
|
<para><computeroutput>void widget_set_situations_value (int value)</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>value</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1a45d8a02844578e1c13d8b86b74e3c8b0"/><section>
|
|
<title>window_design_topbar_left()</title>
|
|
<indexterm><primary>window_design_topbar_left</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</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>
|
|
<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>As this division is clear and constant, it is simpler to place these two half-pages at the same hierarchical level as the other full pages like "synth", "state" or "results".</para>
|
|
|
|
<para>So there is no: "widget_get_rules_page()" function. Instead, the distribution: "all rules" versus "the selected one" is moved to the file: "signal".</para>
|
|
|
|
<para>It is in the function: static void switch_state_rules_data() { switch (<link linkend="_fsm_8h_1a90ab14081a88752d3721947a4922ee25">fsm_get_state_rules_data()</link>) { ... case (RULES) : GtkPaned *widget_all_vs_selected_one = ... break; ... }</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>*header_bar</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_widget_8h_1a4a9ccdb6dc6dbc18f1e2d2235fbb26c3"/><section>
|
|
<title>window_design_topbar_right()</title>
|
|
<indexterm><primary>window_design_topbar_right</primary><secondary>widget.h</secondary></indexterm>
|
|
<indexterm><primary>widget.h</primary><secondary>window_design_topbar_right</secondary></indexterm>
|
|
<para><computeroutput>void window_design_topbar_right (GtkWidget * header_bar, GtkApplication * app)</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>*header_bar</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>*app</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
</section>
|
|
</section>
|