// swad_layout.h: page layout

#ifndef _SWAD_LAY
#define _SWAD_LAY
/*
    SWAD (Shared Workspace At a Distance in Spanish),
    is a web platform developed at the University of Granada (Spain),
    and used to support university teaching.

    This file is part of SWAD core.
    Copyright (C) 1999-2024 Antonio Caņas Vargas

    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/>.
*/
/*****************************************************************************/
/********************************* Headers ***********************************/
/*****************************************************************************/

#include "swad_action.h"
#include "swad_icon.h"
#include "swad_view.h"

/*****************************************************************************/
/****************************** Public constants *****************************/
/*****************************************************************************/

#define Lay_HIDE_BOTH_COLUMNS	0						// 00
#define Lay_SHOW_RIGHT_COLUMN	1						// 01
#define Lay_SHOW_LEFT_COLUMN	2						// 10
#define Lay_SHOW_BOTH_COLUMNS (Lay_SHOW_LEFT_COLUMN | Lay_SHOW_RIGHT_COLUMN)	// 11

#define Lay_NUM_LAST_ITEM 2
typedef enum
  {
   Lay_NO_LAST_ITEM,
   Lay_LAST_ITEM,
  } Lay_LastItem_t;

#define Lay_NUM_HORIZONTAL_LINE_AT_RIGHT 2
typedef enum
  {
   Lay_NO_HORIZONTAL_LINE_AT_RIGHT,
   Lay_HORIZONTAL_LINE_AT_RIGHT,
  } Lay_HorizontalLineAtRight_t;

#define Lay_NUM_HIGHLIGHT 2
typedef enum
  {
   Lay_NO_HIGHLIGHT,
   Lay_HIGHLIGHT,
  } Lay_Highlight_t;

/*****************************************************************************/
/****************************** Public prototypes ****************************/
/*****************************************************************************/

void Lay_WriteStartOfPage (void);

void Lay_WriteHTTPStatus204NoContent (void);

void Lay_WriteEndOfPage (void);

void Lay_PutContextualLinkOnlyIcon (Act_Action_t NextAction,const char *Anchor,
				    void (*FuncPars) (void *Args),void *Args,
				    const char *Icon,Ico_Color_t Color);
void Lay_PutContextualLinkIconText (Act_Action_t NextAction,const char *Anchor,
				    void (*FuncPars) (void *Args),void *Args,
				    const char *Icon,Ico_Color_t Color,
				    const char *Text,const char *OnSubmit);
void Lay_PutContextualCheckbox (Act_Action_t NextAction,
                                void (*FuncPars) (void *Args),void *Args,
                                const char *CheckboxName,
                                Cns_Checked_t Checked,
                                Cns_Disabled_t Disabled,
                                const char *Title,const char *Text);

void Lay_WriteAboutZone (void);

void Lay_RefreshNotifsAndConnected (void);
void Lay_RefreshLastClicks (void);

void Lay_WriteHeaderClassPhoto (Vie_ViewType_t ViewType);

void Lay_AdvertisementMobile (void);

void Lay_IndentDependingOnLevel (unsigned Level,
				 const Lay_LastItem_t *IsLastItemInLevel,
				 Lay_HorizontalLineAtRight_t HorizontalLineAtRight);

void Lay_HelpPlainEditor (void);
void Lay_HelpRichEditor (void);

void Lay_BeginHTMLFile (FILE *File,const char *Title);

void Lay_WriteIndex (unsigned Index,const char *Class);
void Lay_WriteLinkToUpdate (const char *Txt,const char *OnSubmit);

//-------------------------------- Figures ------------------------------------
void Lay_GetAndShowNumUsrsPerSideColumns (void);

#endif