swad-core/swad_agenda.h

// swad_agenda.h: user's agenda (personal organizer)

#ifndef _SWAD_AGD
#define _SWAD_AGD
/*
    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-2016 Antonio Ca<EFBFBD>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_date.h"
#include "swad_user.h"

/*****************************************************************************/
/************************** Public types and constants ***********************/
/*****************************************************************************/

#define Loc_MAX_LENGTH_LOCATION	255
#define Loc_MAX_LENGTH_EVENT	255

#define Loc_MAX_LENGTH_FOLDER 32

#define Loc_NUM_TYPES_SEND_WORK 2
typedef enum
  {
   Loc_DO_NOT_SEND_WORK = 0,
   Loc_SEND_WORK        = 1,
  } Loc_SendWork_t;

#define Loc_NUM_DATES 2
typedef enum
  {
   Loc_START_TIME = 0,
   Loc_END_TIME   = 1,
  } Loc_StartOrEndTime_t;

struct AgendaEvent
  {
   long AgdCod;
   bool Hidden;
   long UsrCod;
   time_t TimeUTC[Loc_NUM_DATES];
   bool Open;
   char Event[Loc_MAX_LENGTH_EVENT+1];
   char Location[Loc_MAX_LENGTH_LOCATION+1];
  };

typedef enum
  {
   Loc_ORDER_BY_START_DATE = 0,
   Loc_ORDER_BY_END_DATE   = 1,
  } Loc_Order_t;

#define Loc_DEFAULT_ORDER_TYPE Loc_ORDER_BY_START_DATE

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

void Agd_SeeEvents (void);
void Agd_PutHiddenParamEventsOrderType (void);
void Agd_RequestCreatOrEditEvent (void);
void Agd_GetListEvents (void);
void Agd_GetDataOfEventByCod (struct AgendaEvent *AgdEvent);
void Agd_FreeListEvents (void);

long Agd_GetParamAgdCod (void);
void Agd_AskRemEvent (void);
void Agd_RemoveEvent (void);
void Agd_HideEvent (void);
void Agd_ShowEvent (void);
void Agd_RecFormEvent (void);
void Agd_RemoveUsrEvents (long UsrCod);
unsigned Agd_GetNumEventsFromUsr (long UsrCod);

unsigned Agd_GetNumUsrsWithEvents (Sco_Scope_t Scope);
unsigned Agd_GetNumEvents (Sco_Scope_t Scope);

#endif