11 files changed, 559 insertions, 12 deletions

diff --git a/include/gui/button.h b/include/gui/button.h
index 62f75a3..6f91e37 100644
--- a/include/gui/button.h
+++ b/include/gui/button.h
@@ -3,14 +3,73 @@
 
 /**
  * File: button.h
+ * Buttons handling
  */
 
+#include <stdbool.h>
+#include "component.h"
+
+/**
+ * Struct: Button
+ * Component that can be triggered by click to execute a specific action.
+ *
+ * Fields:
+ *   component - component that will acted as a button thanks to a rightful initialization
+ *   *label - title on the button
+ *   sizeInterligne - parameter that change padding of the button
+ */
 typedef struct {
   Component component;
+  char *label;
+  int sizeInterligne;
 } Button;
 
-void button_init(Button *button, char *text);
+/**
+ * Function: button_init
+ * Initializes the button.
+ *
+ * Parameters:
+ *  *button - pointer to the input button
+ *  text - label for the button
+ *  sizeInterligne - parameter to initialize padding inside the button
+ *  x_pos - position of the button on x axis
+ *  y_pos - position of the button on y axis
+ *  clickHandler - pointer of function that will be loaded inside our button to perform its purpose
+ */
+void button_init(Button *button, const char *text, int sizeInterligne, int x_pos, int y_pos, ClickHandler clickHandler);
 
-void button_free(Button *button);
+/**
+ * Function: button_print
+ * Prints the button.
+ *
+ * Parameters:
+ *  *parameterSelf - pointer to the button
+ */
+void button_print(Component *parameterSelf);
+
+/**
+ * Function: button_click_test
+ * Debug function to test if the click is working on the current button.
+ *
+ * Parameters:
+ *  x - position of the click on x axis
+ *  y - position of the click on y axis
+ *  *parameterSelf - pointer on the button that is clicked
+ */
+void button_click_test(int x, int y, Component *parameterSelf);
+
+/**
+ * Function: button_is_selected
+ * Checks if the button is selected or not.
+ *
+ * Parameters:
+ *  x - position in x for the check
+ *  y - position in y for the check
+ *  *button - pointer to the current button
+ *
+ * Returns:
+ *  A bool from stdbool
+ */
+bool button_is_selected(int x, int y, Button *button);
 
 #endif
diff --git a/include/gui/component.h b/include/gui/component.h
new file mode 100644
index 0000000..dd101dc
--- /dev/null
+++ b/include/gui/component.h
@@ -0,0 +1,46 @@
+#ifndef UPEM_C_COMPONENT_H
+#define UPEM_C_COMPONENT_H
+
+#include <stdbool.h>
+/**
+ * File: component.h
+ * Windows and components handling.
+ *
+ * See also:
+ *  The famous OS
+ */
+struct Component;
+
+/**
+ * Type: ClickHandler
+ * Type of functions that handle mouse's clicks.
+ */
+typedef void (*ClickHandler)(int x_pos, int y_pos, struct Component *parameter);
+
+/**
+ * Type: PrintMethod
+ * Type of functions that will be used to print our component. This must be initialized by the initialization function of the component.
+ */
+typedef void (*PrintMethod)(struct Component *);
+
+/**
+ * Struct: Component
+ * Represents an abstract module handling clicks and a way to be print on the screen.
+ *
+ * Fields:
+ *  width - width of the component
+ *  height - height of the component
+ *  x_pos - position on the x axis from the origin meant to be placed in top left
+ *  y_pos - position on the y axis from the origin meant to be placed in top left
+ *  click_handler - pointer of function that is called on mouse click
+ *  print_method - pointer of function that handle the component's print
+ */
+typedef struct Component {
+  int width, height;
+  int x_pos, y_pos;
+  bool activated;
+  ClickHandler click_handler;
+  PrintMethod print_method;
+} Component;
+
+#endif //UPEM_C_COMPONENT_H
diff --git a/include/gui/group.h b/include/gui/group.h
index 6914d55..2a02ee4 100644
--- a/include/gui/group.h
+++ b/include/gui/group.h
@@ -3,17 +3,91 @@
 
 /**
  * File: group.h
+ * Group of components
  */
+#include "component.h"
 
+/**
+ * Struct: _GroupElement
+ * Node of the linked list that is involved in the Group behavior
+ *
+ * Parameters:
+ *  *component - component
+ *  *sub_component - sub component
+ *  *next - link to the next node
+ */
+typedef struct _GroupElement {
+  Component *sub_component;
+  struct _GroupElement *next;
+} GroupElement;
+
+/**
+ * Struct: Group
+ * Group representation
+ *
+ * Parameters:
+ *  component - Component used for the Group to catch clicks and handle print to delegate to the components contented in it
+ *  *group_head - pointer to the head of the list that regroup all the components contained inside of the group
+ *  margin - margin for all components
+ */
 typedef struct {
   Component component;
-  Component *sub_components;
+  GroupElement *group_head;
+  int margin;
 } Group;
 
-void group_init(Group *group, int padding);
+/**
+ * Function: group_print
+ * Print method for a group that will print all components contained in.
+ *
+ * Parameters:
+ *  *parameterSelf - pointer that will be casted into a Group to print
+ */
+void group_print(Component *parameterSelf);
+
+/**
+ * Function: group_click_handler
+ * Delegates the click handling to the component contained inside.
+ *
+ * Parameters:
+ *  x_pos - position of the mouse on x axis
+ *  y_pos - position of the mouse on y axis
+ *  *parameterSelf - pointer that will be casted into a Group to print
+ */
+void group_click_handler(int x_pos, int y_pos, Component *parameterSelf);
+
+/**
+ * Function: group_init
+ * Initializes fields of a Group that must be allocated before.
+ *
+ * Parameters:
+ *  *group - group that must be initialized
+ *  width - width of the current group
+ *  height - height of the current group
+ *  x_pos - position on the x axis from the upper left corner
+ *  y_pos - position on the y axis from the upper left corner
+ *  margin - space between each components
+ */
+void group_init(Group *group, int width, int height, int x_pos, int y_pos, int margin);
 
+/**
+ * Function: group_free
+ * Frees the resources held by the group like the linked list.
+ *
+ * Parameters:
+ *  *group - group that must be freed
+ */
 void group_free(Group *group);
 
+/**
+ * Function: group_add_component
+ * Adds the component at the end of the chained list held by group_head.
+ *
+ * Parameters:
+ *  *group - group in which we add the component
+ *  *component - component which is added to the group
+ */
 void group_add_component(Group *group, Component *component);
 
+
 #endif
diff --git a/include/gui/pictureframe.h b/include/gui/pictureframe.h
index 59aaf3b..f194feb 100644
--- a/include/gui/pictureframe.h
+++ b/include/gui/pictureframe.h
@@ -1,6 +1,8 @@
 #ifndef UPEM_MORPHING_PITUREFRAME
 #define UPEM_MORPHING_PITUREFRAME
 
+#include <blender/canvas.h>
+
 /**