swad-core/swad_notice.h

87 lines
3.0 KiB
C

// swad_notice.h: notices (yellow notes)
#ifndef _SWAD_NOT
#define _SWAD_NOT
/*
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-2023 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_statistic.h"
/*****************************************************************************/
/******************************* Public types ********************************/
/*****************************************************************************/
#define Not_NUM_TYPES_LISTING 2
typedef enum
{
Not_LIST_BRIEF_NOTICES = 0,
Not_LIST_FULL_NOTICES = 1,
} Not_Listing_t;
#define Not_NUM_STATUS 2
typedef enum
{
Not_ACTIVE_NOTICE = 0,
Not_OBSOLETE_NOTICE = 1,
} Not_Status_t; // Don't change these numbers because they are used in database
struct Not_Notice
{
long NotCod;
long UsrCod;
time_t CreatTime;
Not_Status_t Status;
char Content[Cns_MAX_BYTES_TEXT + 1];
};
/*****************************************************************************/
/***************************** Public prototypes *****************************/
/*****************************************************************************/
void Not_ShowFormNotice (void);
void Not_ReceiveNotice (void);
void Not_ListNoticesAfterRemoval (void);
void Not_ListFullNotices (void);
void Not_GetHighLightedNotCod (void);
void Not_HideActiveNotice (void);
void Not_RevealHiddenNotice (void);
void Not_ReqRemNotice (void);
void Not_RemoveNotice (void);
void Not_ShowNotices (Not_Listing_t TypeNoticesListing,long HighlightNotCod);
void Not_GetSummaryAndContentNotice (char SummaryStr[Ntf_MAX_BYTES_SUMMARY + 1],
char **ContentStr,
long NotCod,bool GetContent);
unsigned Not_GetNumNotices (HieLvl_Level_t Scope,Not_Status_t Status,unsigned *NumNotif);
unsigned Not_GetNumNoticesDeleted (HieLvl_Level_t Scope,unsigned *NumNotif);
//-------------------------------- Figures ------------------------------------
void Not_GetAndShowNoticesStats (void);
#endif