44 lines
2.5 KiB
XML
44 lines
2.5 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="_doc_2readme_8dox" xml:lang="en-US">
|
||
|
|
<title>doc/readme.dox File Reference</title>
|
||
|
|
<indexterm><primary>doc/readme.dox</primary></indexterm>
|
||
|
|
<para>
|
||
|
|
|
||
|
|
<para>Gem-graph-client doc readme.dox file. </para>
|
||
|
|
|
||
|
|
</para>
|
||
|
|
<section>
|
||
|
|
<title>Detailed Description</title>
|
||
|
|
|
||
|
|
<para>Gem-graph-client doc readme.dox file. </para>
|
||
|
|
|
||
|
|
<para>This file is part of Gem-graph.</para>
|
||
|
|
|
||
|
|
<para>The code files are all located in the src (sources) directory (the headers in 'include'). They are divided into several <emphasis role="bold">types of organisation</emphasis>:</para>
|
||
|
|
|
||
|
|
<para><itemizedlist>
|
||
|
|
<listitem>
|
||
|
|
<para><emphasis>hierarchical</emphasis>: the widgets that give the windows their appearance are organised in the form of a tree. Windows are the first level of depth. Next come the title bar and the pages designed to occupy the window space below the title bar. Each of these pages has its own hierarchical structure: it can be divided into horizontal or vertical strips, which can themselves be divided in the same way, with varying levels of depth right down to the last boxes, which contain lists of widgets such as buttons, sliders or images.</para>
|
||
|
|
</listitem><listitem>
|
||
|
|
<para><emphasis>list</emphasis>: the main <emphasis>sections</emphasis> of the fsm (finite state machine) constitute a list of at least four elements, each of which defines a set of possible states :<orderedlist>
|
||
|
|
<listitem>
|
||
|
|
<para>execute or edit (managing the appropriate tools states in both cases)</para>
|
||
|
|
</listitem><listitem>
|
||
|
|
<para>measure, operate on data, prepare displayable results</para>
|
||
|
|
</listitem><listitem>
|
||
|
|
<para>apply user preferences</para>
|
||
|
|
</listitem><listitem>
|
||
|
|
<para>indicate the desired state of windows and widgets</para>
|
||
|
|
</listitem></orderedlist>
|
||
|
|
The state of the fsm is uniquely defined at all times by all the parameters listed in these sections. All program actions depend on this state.</para>
|
||
|
|
</listitem><listitem>
|
||
|
|
<para><emphasis>transversal</emphasis>: the other functions that must be easily accessible by all the previous functions. They are therefore all located at the root. These are the functions that manage graphics, callbacks, utilities and the log.</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>
|
||
|
|
</section>
|
||
|
|
</section>
|