58 lines
2.5 KiB
Plaintext
58 lines
2.5 KiB
Plaintext
|
/**
|
||
|
|
* @page
|
||
|
|
* @file
|
||
|
|
* Gem-graph-client doc readme.dox file. (the .c extension is just crap)
|
||
|
|
*
|
||
|
|
* This file is part of Gem-graph.
|
||
|
|
*
|
||
|
|
* The code files are all located in the src (sources) directory
|
||
|
|
* (the headers in 'include').
|
||
|
|
* They are divided into several **types of organisation**:
|
||
|
|
*
|
||
|
|
* - *hierarchical*: 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.
|
||
|
|
*
|
||
|
|
* - *list*: the main *sections* of the fsm (finite state machine) constitute
|
||
|
|
* a list of at least four elements, each of which defines a set of possible
|
||
|
|
* states :
|
||
|
|
* -# execute or edit (managing the appropriate tools states in both cases)
|
||
|
|
* -# measure, operate on data, prepare displayable results
|
||
|
|
* -# apply user preferences
|
||
|
|
* -# indicate the desired state of windows and widgets
|
||
|
|
* .
|
||
|
|
* 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.
|
||
|
|
*
|
||
|
|
* - *transversal*: 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.
|
||
|
|
*
|
||
|
|
* ---
|
||
|
|
*
|
||
|
|
* @cond LICENSE
|
||
|
|
* Copyright © 2021 Libre en Communs <contact@a-lec.org>
|
||
|
|
* Copyright © 2021-2024 Adrien Bourmault <neox@a-lec.org>
|
||
|
|
* Copyright © 2021-2024 Jean Sirmai <jean@a-lec.org>
|
||
|
|
*
|
||
|
|
* This program is free software: you can redistribute it and/or modify it under
|
||
|
|
* the terms of the GNU Affero General Public License as published by the Free
|
||
|
|
* Software Foundation, either version 3 of the License, or (at your option) any
|
||
|
|
* later version.
|
||
|
|
*
|
||
|
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
||
|
|
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
|
||
|
|
* details.
|
||
|
|
*
|
||
|
|
* You should have received a copy of the GNU Affero General Public License
|
||
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||
|
|
* @endcond
|
||
|
|
*/
|