gem-graph-client/doc/docbook/d5/d03/left_8c.xml

197 lines
8.9 KiB
XML
Raw Normal View History

<?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="_left_8c" xml:lang="en-US">
<title>src/widget/main_window/topbar/left.c File Reference</title>
<indexterm><primary>src/widget/main_window/topbar/left.c</primary></indexterm>
<para>
2024-10-25 17:32:30 +02:00
<para>Topbar left design. </para>
</para>
2024-10-25 22:12:02 +02:00
<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>Include dependency graph for left.c:<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata width="50%" align="center" valign="middle" scalefit="0" fileref="../../d3/d02/left_8c__incl.svg"></imagedata>
2024-10-25 22:12:02 +02:00
</imageobject>
</mediaobject>
</informalfigure>
</para>
<simplesect>
<title>Macros </title>
<itemizedlist>
<listitem><para><anchor xml:id="_left_8c_1a570930b5f05abce00f0655fee5972eba"/>#define <emphasis role="strong">WANT_TO_START_ON_ANOTHER_PAGE</emphasis>&#160;&#160;&#160;0</para>
<para>default == SYNTH </para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para>const char * <link linkend="_left_8c_1a3d0f8c7b9545a6da3464060dad7990db">widget_get_btt_label_synth</link> ()</para>
</listitem>
2024-10-25 17:32:30 +02:00
<listitem><para>const char * <link linkend="_left_8c_1a22ed4aed09c29d9f8c72dbe7ced53e2c">widget_get_btt_label_state</link> ()</para>
</listitem>
2024-10-25 17:32:30 +02:00
<listitem><para>const char * <link linkend="_left_8c_1adea9b5591d51aab274d8c275045d778c">widget_get_btt_label_rules</link> ()</para>
</listitem>
2024-10-25 17:32:30 +02:00
<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>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
2024-10-25 17:32:30 +02:00
<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>
2024-10-25 17:32:30 +02:00
<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>
Here is the caller graph for this function:<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata width="50%" align="center" valign="middle" scalefit="0" fileref="../../d5/d03/left_8c_a136322baea0729a8dfbc5c9b1bc0667e_icgraph.svg"></imagedata>
</imageobject>
</mediaobject>
</informalfigure>
</para>
2024-10-25 17:32:30 +02:00
</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>
Here is the caller graph for this function:<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata width="50%" align="center" valign="middle" scalefit="0" fileref="../../d5/d03/left_8c_adea9b5591d51aab274d8c275045d778c_icgraph.svg"></imagedata>
</imageobject>
</mediaobject>
</informalfigure>
</para>
2024-10-25 17:32:30 +02:00
</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>
Here is the caller graph for this function:<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata width="50%" align="center" valign="middle" scalefit="0" fileref="../../d5/d03/left_8c_a22ed4aed09c29d9f8c72dbe7ced53e2c_icgraph.svg"></imagedata>
</imageobject>
</mediaobject>
</informalfigure>
</para>
2024-10-25 17:32:30 +02:00
</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>
2024-10-25 17:32:30 +02:00
<para><computeroutput>const char * widget_get_btt_label_synth ( )</computeroutput></para>
<para><formalpara><title>Returns</title>
2024-10-25 17:32:30 +02:00
<para>&quot;synth&quot; <?linebreak?> </para>
</formalpara>
</para>
Here is the caller graph for this function:<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata width="50%" align="center" valign="middle" scalefit="0" fileref="../../d5/d03/left_8c_a3d0f8c7b9545a6da3464060dad7990db_icgraph.svg"></imagedata>
</imageobject>
</mediaobject>
</informalfigure>
</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>
2024-10-25 17:32:30 +02:00
<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>
<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 &quot;synth&quot;, &quot;state&quot; or &quot;results&quot;.</para>
<para>So there is no: &quot;widget_get_rules_page()&quot; function. Instead, the distribution: &quot;all rules&quot; versus &quot;the selected one&quot; is moved to the file: &quot;signal&quot;.</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>
Here is the call graph for this function:<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata width="50%" align="center" valign="middle" scalefit="0" fileref="../../d5/d03/left_8c_a45d8a02844578e1c13d8b86b74e3c8b0_cgraph.svg"></imagedata>
</imageobject>
</mediaobject>
</informalfigure>
</para>
Here is the caller graph for this function:<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata width="50%" align="center" valign="middle" scalefit="0" fileref="../../d5/d03/left_8c_a45d8a02844578e1c13d8b86b74e3c8b0_icgraph.svg"></imagedata>
</imageobject>
</mediaobject>
</informalfigure>
</para>
</section>
</section>
</section>