A Class For Generating/Manipulating HKBF, iCal, Reports And Other Documents. More...

#include <Documents.h>

Public Member Functions
	HK_Documents ()
	Constructor. More...

string	BatchHTMLReport (HK_Batch Batch, HK_KeyValue Settings)
	Returns An HTML String For Printing Reports. More...

string	BatchICal (HK_Batch Batch, bool DatesOnly)
	Generates iCal Text With Batch Data. More...

string	BatchTextReport (HK_Batch Batch, HK_KeyValue Settings)
	Returns A Text Batch Report For Archiving Batch Data. More...

bool	ExportHKBF (string Filename, HK_Batches Batches, HK_Storage Groups)
	Overloaded: Exports Multiple Batches, and a Group To A hkbf(xml) File. More...

bool	ExportHKBF (string Filename, HK_Batches Batches, HK_Storage Groups, HK_Storage Types, HK_Storage Breeds, HK_Storage Schedules)
	Exports Batches, Groups, Types, Breeds, and Schedules. More...

string	GroupHTMLReport (HK_Batches GrBatches, string GroupName, string Comments, HK_KeyValue Settings)

string	GroupTextReport (HK_Batches GrBatches, string GroupName, string Comments, HK_KeyValue Settings)
	Generates A Text Group Report For Archiving. More...

string	GroupICal (HK_Batches GrBatches, string GroupName)
	Generates iCal Text With Group Data. More...

string	HTMLCalendar (HK_Date Selection, HK_Batches Batches)
	Generates A HTML Calendar For This HK_Month Using Dates From Batches. More...

vector< string >	ImportHKBF (string Filename, HK_Batches Batches, HK_Storage Groups, HK_Storage Types, HK_Storage Breeds, HK_Storage *Schedules)
	Tries Reading And Generating HK_Batch Objects From HKBF. More...

Detailed Description

A Class For Generating/Manipulating HKBF, iCal, Reports And Other Documents.

class HK_Documents

Definition at line 27 of file Documents.h.

Constructor & Destructor Documentation

◆ HK_Documents()

HK_Documents::HK_Documents ( )

Constructor.

Definition at line 11 of file HK_Documents.cpp.

Member Function Documentation

◆ BatchHTMLReport()

string HK_Documents::BatchHTMLReport	(	HK_Batch	Batch,
		HK_KeyValue	Settings
	)

Returns An HTML String For Printing Reports.

Definition at line 856 of file HK_Documents.cpp.

◆ BatchICal()

string HK_Documents::BatchICal	(	HK_Batch	Batch,
		bool	DatesOnly
	)

Generates iCal Text With Batch Data.

Definition at line 1077 of file HK_Documents.cpp.

◆ BatchTextReport()

string HK_Documents::BatchTextReport	(	HK_Batch	Batch,
		HK_KeyValue	Settings
	)

Returns A Text Batch Report For Archiving Batch Data.

Definition at line 752 of file HK_Documents.cpp.

◆ ExportHKBF() [1/2]

bool HK_Documents::ExportHKBF	(	string	Filename,
		HK_Batches	Batches,
		HK_Storage	Groups
	)

Overloaded: Exports Multiple Batches, and a Group To A hkbf(xml) File.

Definition at line 14 of file HK_Documents.cpp.

◆ ExportHKBF() [2/2]

bool HK_Documents::ExportHKBF	(	string	Filename,
		HK_Batches	Batches,
		HK_Storage	Groups,
		HK_Storage	Types,
		HK_Storage	Breeds,
		HK_Storage	Schedules
	)

Exports Batches, Groups, Types, Breeds, and Schedules.

Definition at line 25 of file HK_Documents.cpp.

◆ GroupHTMLReport()

string HK_Documents::GroupHTMLReport	(	HK_Batches	GrBatches,
		string	GroupName,
		string	Comments,
		HK_KeyValue	Settings
	)

Definition at line 1052 of file HK_Documents.cpp.

◆ GroupICal()

string HK_Documents::GroupICal	(	HK_Batches	GrBatches,
		string	GroupName
	)

Generates iCal Text With Group Data.

Definition at line 1197 of file HK_Documents.cpp.

◆ GroupTextReport()

string HK_Documents::GroupTextReport	(	HK_Batches	GrBatches,
		string	GroupName,
		string	Comments,
		HK_KeyValue	Settings
	)

Generates A Text Group Report For Archiving.

Definition at line 1018 of file HK_Documents.cpp.

◆ HTMLCalendar()

string HK_Documents::HTMLCalendar	(	HK_Date	Selection,
		HK_Batches	Batches
	)

Generates A HTML Calendar For This HK_Month Using Dates From Batches.

Definition at line 1222 of file HK_Documents.cpp.

◆ ImportHKBF()

vector< string > HK_Documents::ImportHKBF	(	string	Filename,
		HK_Batches *	Batches,
		HK_Storage *	Groups,
		HK_Storage *	Types,
		HK_Storage *	Breeds,
		HK_Storage *	Schedules
	)

Tries Reading And Generating HK_Batch Objects From HKBF.

Parameters

Filename	The Patch And Filename Of The File To Import
Group	A String Reference To Hold Group Name. Will Be Unmodified If It's Not A Group HKBF.
Comments	A String Reference To Hold Group Comments. Will Be Unmodified If It's Not A Group HKBF.

Returns: Empty HK_Batches On Error

Definition at line 271 of file HK_Documents.cpp.

The documentation for this class was generated from the following files:

/home/millj/Documents/1-Code/HatchKeeper/headers/Documents.h
/home/millj/Documents/1-Code/HatchKeeper/src/HK_Documents.cpp

Public Member Functions