environmentalUtils.h File Reference

Go to the source code of this file.

Functions
DT_DLL_vrfExtProtocol bool	getFontInformationFromEnvironmentalFormattingData (const DtString &fd, DtString &font, int &fontSize)
DT_DLL_vrfExtProtocol DtString	setFontInformationFromEnvironmentalFormattingData (const DtString &basefd, DtString font, int fontSize)
DT_DLL_vrfExtProtocol bool	getFontColorFromEnvironmentalFormattingData (const DtString &fd, unsigned int &color)
DT_DLL_vrfExtProtocol DtString	setFontColorFromEnvironmentalFormattingData (const DtString &basefd, unsigned int color)
DT_DLL_vrfExtProtocol bool	getArrowInformationFromEnvironmentalFormattingData (const DtString &fd, int &arrowHeadPlacement, int &arrowStyle, int &arrowSize)
DT_DLL_vrfExtProtocol DtString	setArrowInformationFromEnvironmentalFormattingData (const DtString &basefd, int arrowHeadPlacement, int arrowStyle, int arrowSize)
DT_DLL_vrfExtProtocol time_t	utcTimeFromTimeOfDay (time_t dtod, time_t tod, time_t timezoneOffset=0)
DT_DLL_vrfExtProtocol time_t	localTimeFromTimeOfDay (time_t dtod, time_t tod)
DT_DLL_vrfExtProtocol time_t	utcTimeOfDayFromDateAndTime (time_t dtod)
DT_DLL_vrfExtProtocol void	utcGetTodaysDateAndTime (int &year, int &mon, int &day, int &hour, int &min, int &sec)
DT_DLL_vrfExtProtocol void	localGetTodaysDateAndTime (int &year, int &mon, int &day, int &hour, int &min, int &sec)

Function Documentation

DT_DLL_vrfExtProtocol bool getFontInformationFromEnvironmentalFormattingData	(	const DtString &	fd,
		DtString &	font,
		int &	fontSize
	)

Utility functions for environmentals.

Returns the font information from the given formatting data (if exists)

DT_DLL_vrfExtProtocol DtString setFontInformationFromEnvironmentalFormattingData	(	const DtString &	basefd,
		DtString	font,
		int	fontSize
	)

Given an existing formatted string add font and font size to it.

DT_DLL_vrfExtProtocol bool getFontColorFromEnvironmentalFormattingData	(	const DtString &	fd,
		unsigned int &	color
	)

Returns color of text font (if exists)

DT_DLL_vrfExtProtocol DtString setFontColorFromEnvironmentalFormattingData	(	const DtString &	basefd,
		unsigned int	color
	)

Given an existing formatted string add color to it.

DT_DLL_vrfExtProtocol bool getArrowInformationFromEnvironmentalFormattingData	(	const DtString &	fd,
		int &	arrowHeadPlacement,
		int &	arrowStyle,
		int &	arrowSize
	)

Returns arrow information (if exists)

DT_DLL_vrfExtProtocol DtString setArrowInformationFromEnvironmentalFormattingData	(	const DtString &	basefd,
		int	arrowHeadPlacement,
		int	arrowStyle,
		int	arrowSize
	)

Given an existing formatted string add arrow information to is.

DT_DLL_vrfExtProtocol time_t utcTimeFromTimeOfDay	(	time_t	dtod,
		time_t	tod,
		time_t	timezoneOffset = 0
	)

Given the utc date/time of day and a proposed new time return a new utc time with that new time of day and the existing date. If date/time is 0 uses time(0). Set timezoneOffset to offset base UTC time for timezone.

DT_DLL_vrfExtProtocol time_t localTimeFromTimeOfDay	(	time_t	dtod,
		time_t	tod
	)

Given the utc date/time of day and a proposed new time return a new local time with that new time of day and the existing date. If date/time is 0 uses time(0)

DT_DLL_vrfExtProtocol time_t utcTimeOfDayFromDateAndTime

(

time_t

dtod

)

Returns the time of day portion (UTC) from the given UTC date/time of day.

DT_DLL_vrfExtProtocol void utcGetTodaysDateAndTime	(	int &	year,
		int &	mon,
		int &	day,
		int &	hour,
		int &	min,
		int &	sec
	)

Returns the current date/dime in utc timezone.

DT_DLL_vrfExtProtocol void localGetTodaysDateAndTime	(	int &	year,
		int &	mon,
		int &	day,
		int &	hour,
		int &	min,
		int &	sec
	)

Returns the current date/dime in local timezone.