summaryrefslogtreecommitdiff
path: root/include/gui/group.h
diff options
context:
space:
mode:
authorAdam NAILI2017-12-10 13:28:40 +0100
committerAdam NAILI2017-12-10 13:28:40 +0100
commit3449e695fa8885bb8150e105c267d92ab8a3d4ee (patch)
tree0fdc5eb96ec9c6a993eca18581944e540e27105f /include/gui/group.h
parent2aed52d89856847ea394b06d7b70782fa6b21d24 (diff)
downloadmorpher-3449e695fa8885bb8150e105c267d92ab8a3d4ee.tar.gz
Updating documentation of group.h
Diffstat (limited to 'include/gui/group.h')
-rw-r--r--include/gui/group.h24
1 files changed, 21 insertions, 3 deletions
diff --git a/include/gui/group.h b/include/gui/group.h
index 45ec3b2..bd46852 100644
--- a/include/gui/group.h
+++ b/include/gui/group.h
@@ -1,17 +1,35 @@
1#ifndef UPEM_MORPHING_GROUP 1#ifndef UPEM_MORPHING_GROUP
2#define UPEM_MORPHING_GROUP 2#define UPEM_MORPHING_GROUP
3 3
4#include "window.h"
5
6/** 4/**
7 * File: group.h 5 * File: group.h
6 * Group of components
8 */ 7 */
8#include "window.h"
9 9
10/**
11 * Struct: _GroupElement
12 * Nod of the linked list that is involved in the Group behavior
13 *
14 * Parameters:
15 * *component - component
16 * *sub_component - sub component
17 * *next - link to the next nod
18 */
10typedef struct _GroupElement { 19typedef struct _GroupElement {
11 Component *c; 20 Component *component;
21 Component *sub_component;
12 struct _GroupElement *next; 22 struct _GroupElement *next;
13} GroupElement; 23} GroupElement;
14 24
25/**
26 * Struct: Group
27 * Group representation
28 *
29 * Parameters:
30 * component - Component used for the Group to catch clicks and handle print to delegate to the components contented in it
31 * *group_head - pointer to the head of the list that regroup all the components contained inside of the group
32 */
15typedef struct { 33typedef struct {
16 Component component; 34 Component component;
17 GroupElement *group_head; 35 GroupElement *group_head;