structure.h

#ifndef PAGE_H
#define PAGE_H

#include <Arduino.h>


// please note that each page you create  you are  taking 2% of the arduino
// nano library so make very sure you dont over use the pages system please
// and no  we  are not  goig to  redesign the  page system  we made  it for
// effiency  and reliabl e code  so  dont even  consider changing  anything
// esspcially chaning the  char buffers  they sensitive  esspcially for the   
// how the schedule system works





struct Page;  // this doesnt yet create the structure but it does 
              // tell the next line to know it will exist

typedef void (*ApplyFunction)(Page& page);  // function to excuate when you  press apply this function
                                            // requires the page pointer  that it  is set to so it can 
                                            // access the variables inside

                                            
                                            // example on how to call the function:
                                            // page->apply_function(*page)
                                            // this line of code will run the function  it will access
                                            // apply function from the  page it  will excuate it while
                                            // passing the  


struct Page {

    // the buffers  are going  to be  used to flash them on the lcd display
    // the display  runs  at certain  fps with a schedule  system to  flash
    // the latest buffers, those two char buffers are not to be reallocated
    // reallocate while it is in schedule and the  output system  breaks be
    // aware if you reallocate the buffers  i  will find  you and  only god
    // know what will happen next 


    // do not change the 17 to 16, yes i understand  that the  lcd  only contain
    // 16 visiable bytes per layer but also the string  char require you to have
    // have a ternminator at the end <\0> so this actually ensure the 16th digit
    // or letter or whatever is actually displayed on the lcd

    char title[17];   // e.g. "Time", "Volume", "Frequency" layer one of the lcd
    
    
    char value[17];   // e.g. "12:34", "5", "101.1"         layer two of the lcd




    bool is_visiable = false; // this will tell us if the page is visiaible 

    bool is_editable = false; // this checks if the page is editable and you
                              // can  edit  the values  make sure  that  you
                              // provide apply_function and set this to true
                              // to avoid any errors


    bool is_editing = false; // this will tell us if we are editing the page

    // these where the cursor will be when you edit the values
    uint8_t  cursor_col = 0;  // the x coor on the layer, 0 is all the way left and 16 is all the way right
    uint8_t  cursor_row = 1;  // top lcd layer is 0, bottom lcd layer is 1
    

    bool schedul_update = false; // this will be set to true when the page needs an update
                                 // lcd wise it will schedul_update every time the buffers
                                 // change  to inform  the upper  layer that  they need to
                                 // update note that


    bool is_popup = false; // this will tell us if the page is a popup if it is
                           // and has the show_page set  to true then this will
                           // show the page note  that if  this a popup it will
                           // link back to the page that it came from  

    bool show_page = false; // if this is true it will be displayed on the scren
                            // and the other pages you  need to  write the locic
                            // in the page manager 


    ApplyFunction apply_function;

    Page* next_page;
    Page* prev_page;


};

#endif