viewfmt.h

IBM Lotus C++ API 7.0a for IBM Lotus Notes/Domino Directory Release --------- ------------------

#define CAL_HIDE_MONTH_HEADER		0x0020	/* Don't show the month header in the view (i.e. January 2001) */
#define CAL_HIDE_GOTOTODAY			0x0040	/* Don't show the GoToToday button in the view */
#define CAL_SHOW_TRASHVIEW			0x0080	/* Don't show the trash view in the header */
#define CAL_SHOW_ALLDOCSVIEW		0x0100	/* Don't show the all docs view in the header */
#define CAL_HIDE_FORMATBTN			0x0200	/* Don't show the formatting button */
#define CAL_HIDE_DAYTAB				0x0400	/* Don't show the day tab */
#define CAL_HIDE_WEEKTAB			0x0800	/* Don't show the week tab */
#define CAL_HIDE_MONTHTAB			0x1000	/* Don't show the month tab */
#define CAL_SHOW_DAYPLANNER			0x2000	/* show the header as dayplanner */
#define CAL_HIDE_OWNERNAME			0x4000  /* show the owner name */
#define	VIEW_CALENDAR_RTLVIEW		0x8000	/* TRUE if RTL Calendar, Note: same as VIEW_TABLE_RTLVIEW */
	
	WORD    BusyColor;						/* Color busy times are displayed in */

	WORD    wTimeSlotStart;				 	/* TimeSlot start time (in minutes from midnight) */
	WORD    wTimeSlotEnd;				 	/* TimeSlot end time (in minutes from midnight) */
	WORD    wTimeSlotDuration;			 	/* TimeSlot duration (in minutes) */

	COLOR_VALUE DaySeparatorsColorExt;		/* written by v5; Same meaning as DaySeparatorsColor, but can be any color */
	COLOR_VALUE BusyColorExt;				/* written by v5; Same meaning as BusyColor, but can be any color */

	BYTE	MinorVersion;					/* Minor version */
#define VIEW_CAL_FORMAT_MINOR_V4x	0			/* V4.5, V4.6 has minor version of 0 */
#define VIEW_CAL_FORMAT_MINOR_1		1			/* V5 */
#define VIEW_CAL_FORMAT_MINOR_2		2			/* V5.03 and up  - added custom work week format */
#define VIEW_CAL_FORMAT_MINOR_3		3			/* Calendar Grid Color */
#define VIEW_CAL_FORMAT_MINOR_4		4			/* more damn colors */

	BYTE	InitialFormat;					/* Initial format to display.  0=last viewed by user */
	
	DWORD	CalGridBkColor;					/* Background color of Calendar Grid */
	DWORD	WorkHoursColor;					/* Background color for the work hours in the calendar grid */ 
	DWORD	ToDoBkColor;					/* Background color for the ToDo entry region */
	DWORD	HeaderBkColor;					/* Background color for calendar view's header background */

	} VIEW_CALENDAR_FORMAT;

typedef VIEW_CALENDAR_FORMAT *PVIEW_CALENDAR_FORMAT;


/* 	Secondary Calendar View Format.  Introduced in build 161 (for v5). */

#define VIEW_CALENDAR_FORMAT2_SIGNATURE	0x0323
	
typedef struct
	{
	WORD		Signature;			   		/* VIEW_CALENDAR_FORMAT2_SIGNATURE */

											/* Attributes initialized when MinorVersion = 1 */
	COLOR_VALUE DayDateBkColor;				/* Color for day/date background area */							
	COLOR_VALUE NonMonthBkColor;	 		/* Color for non-month date background area */							
	COLOR_VALUE NonMonthTextColor;	 		/* Color for non-month font */							

	COLOR_VALUE	DayDateColor;				/* V6 - Day and Date display */
	COLOR_VALUE	TimeSlotColor;				/* V6 - Time Slot display */
	COLOR_VALUE	HeaderColor;				/* V6 - Month Headers */
	COLOR_VALUE TodayRGBColor;				/* V6 - Today color */

	FONTID	WeekDayMonthFont;				/* One week view - Day and Month display */

	DWORD		Spare[3];
	} VIEW_CALENDAR_FORMAT2;



/* View column format descriptor.  One per column. */

typedef struct tagVIEW_COLUMN_FORMAT
	{
	WORD	Signature;							/* VIEW_COLUMN_FORMAT_SIGNATURE */
	WORD	Flags1;
#define	VCF1_S_Sort						0		/* Add column to sort */
#define	VCF1_M_Sort						0x0001
#define	VCF1_S_SortCategorize			1		/* Make column a category */
#define	VCF1_M_SortCategorize			0x0002
#define	VCF1_S_SortDescending			2		/* Sort in descending order (ascending if FALSE) */
#define	VCF1_M_SortDescending			0x0004
#define	VCF1_S_Hidden					3		/* Hidden column */
#define	VCF1_M_Hidden					0x0008
#define	VCF1_S_Response					4		/* Response column */
#define	VCF1_M_Response					0x0010
#define	VCF1_S_HideDetail				5		/* Do not show detail on subtotalled columns */
#define	VCF1_M_HideDetail				0x0020
#define	VCF1_S_Icon						6		/* Display icon instead of text */
#define	VCF1_M_Icon						0x0040
#define	VCF1_S_NoResize					7		/* Resizable at run time. */
#define	VCF1_M_NoResize					0x0080
#define	VCF1_S_ResortAscending			8		/* Resortable in ascending order. */
#define	VCF1_M_ResortAscending			0x0100
#define	VCF1_S_ResortDescending			9		/* Resortable in descending order. */
#define	VCF1_M_ResortDescending			0x0200
#define	VCF1_S_Twistie					10		/* Show twistie if expandable. */
#define	VCF1_M_Twistie					0x0400
#define	VCF1_S_ResortToView				11		/* Resort to a view. */
#define	VCF1_M_ResortToView				0x0800
#define	VCF1_S_SecondResort				12		/* Secondary resort column set. */
#define	VCF1_M_SecondResort				0x1000
#define	VCF1_S_SecondResortDescending	13		/* Secondary column resort descending (ascending if clear). */
#define	VCF1_M_SecondResortDescending	0x2000
/* The following 4 constants are obsolete - see new VCF3_ constants below. */
#define	VCF1_S_CaseInsensitiveSort		14		/* Case insensitive sorting. */
#define	VCF1_M_CaseInsensitiveSort		0x4000
#define	VCF1_S_AccentInsensitiveSort	15		/* Accent insensitive sorting. */
#define	VCF1_M_AccentInsensitiveSort	0x8000

	WORD	ItemNameSize;						/* Item name string size */
	WORD	TitleSize;							/* Title string size */
	WORD	FormulaSize;						/* Compiled formula size */
	WORD	ConstantValueSize;					/* Constant value size */
	WORD	DisplayWidth;						/* Display width - 1/8 ave. char width units */
	FONTID	FontID;								/* Display font ID */
	WORD	Flags2;
#define	VCF2_S_DisplayAlignment			0		/* Display alignment - VIEW_COL_ALIGN_XXX */
#define	VCF2_M_DisplayAlignment			0x0003
#define	VCF2_S_SubtotalCode				2		/* Subtotal code (NIF_STAT_xxx) */
#define	VCF2_M_SubtotalCode				0x003c
#define	VCF2_S_HeaderAlignment			6		/* Header alignment - VIEW_COL_ALIGN_XXX */
#define	VCF2_M_HeaderAlignment			0x00c0
#define	VCF2_S_SortPermute				8		/* Make column permuted if multi-valued */
#define	VCF2_M_SortPermute				0x0100
#define	VCF2_S_SecondResortUniqueSort	9		/* Secondary resort column props different from column def.*/
#define	VCF2_M_SecondResortUniqueSort	0x0200
#define	VCF2_S_SecondResortCategorized	10		/* Secondary resort column categorized. */
#define	VCF2_M_SecondResortCategorized	0x0400
#define	VCF2_S_SecondResortPermute		11		/* Secondary resort column permuted. */
#define	VCF2_M_SecondResortPermute		0x0800
#define	VCF2_S_SecondResortPermutePair 	12		/* Secondary resort column pairwise permuted. */
#define	VCF2_M_SecondResortPermutePair	0x1000
#define	VCF2_S_ShowValuesAsLinks		13		/* Show values as links when viewed by web browsers. */
#define	VCF2_M_ShowValuesAsLinks		0x2000
#define	VCF2_S_DisplayReadingOrder		14		/* Display Reading order - VIEW_COL_XXX */
#define	VCF2_M_DisplayReadingOrder		0x4000
#define	VCF2_S_HeaderReadingOrder		15		/* Header Reading order - VIEW_COL_XXX */
#define	VCF2_M_HeaderReadingOrder		0x8000

	NFMT	NumberFormat;						/* Number format specification */
	TFMT	TimeFormat;							/* Time format specification */
	WORD	FormatDataType;						/* Last format data type */
	WORD	ListSep;							/* List Separator */
	} VIEW_COLUMN_FORMAT;	

/* View column display alignment.  */
/*		Note: order and values are assumed in VIEW_ALIGN_XXX_ID's. */

#define VIEW_COL_ALIGN_LEFT		0				/* Left justified */
#define VIEW_COL_ALIGN_RIGHT	1				/* Right justified */
#define VIEW_COL_ALIGN_CENTER	2				/* Centered */

/* View column display reading order.  */

#define VIEW_COL_LTR	0						/* Left To Right reading order */
#define VIEW_COL_RTL	1						/* Right To Left reading order */

/* Simple format data types, used to initialize dialog box to last "mode". */

#define VIEW_COL_NUMBER 0
#define VIEW_COL_TIMEDATE 1
#define VIEW_COL_TEXT 2

/*	Extended View column format descriptor.  One per column as of Notes V4.
	NOTE:  If you add variable data to this structure, store the packed,
	variable data AFTER the array of structures. */

typedef struct
	{
	WORD	Signature;								/* VIEW_COLUMN_FORMAT_SIGNATURE2 */
	FONTID	HeaderFontID;							/* FontID of column header. */
	UNID	ResortToViewUNID;						/* UNID of view to switch to. */
	WORD	wSecondResortColumnIndex;				/* 0 based index of secondary resort column. */
	WORD	Flags3;						
#define	VCF3_S_FlatInV5 					0		/* View is flat in V5 or greater */
#define	VCF3_M_FlatInV5 					0x0001
#define	VCF3_S_CaseSensitiveSortInV5		1		/* Case Sensitive sorting. */
#define	VCF3_M_CaseSensitiveSortInV5		0x0002
#define	VCF3_S_AccentSensitiveSortInV5		2		/* Accent Sensitive sorting. */
#define	VCF3_M_AccentSensitiveSortInV5		0x0004
#define VCF3_S_HideWhenFormula				3		/* Column has hide/when formula set */
#define VCF3_M_HideWhenFormula				0x0008	
#define VCF3_S_TwistieResource				4		
#define VCF3_M_TwistieResource				0x0010	
#define VCF3_S_Color						5		/* Column value to be used as a color for this entry. */
#define VCF3_M_Color						0x0020	
											/* 6 */
#define VCF3_ExtDate						0x0040	/*column has extended date info*/
											/* 7 */
#define VCF3_NumberFormat					0x0080	/*column has extended number format*/
#define VCF3_S_IsColumnEditable				8		/* v6 - can this column be edited */
#define VCF3_M_IsColumnEditable				0x0100	/* V6 - color col and user definable color */
#define VCF3_S_UserDefinableColor			9
#define VCF3_M_UserDefinableColor			0x0200	
#define VCF3_S_HideInR5						10		/* Column has hide/when formula set and needs to be hidden in R5 or before*/
#define VCF3_M_HideInR5						0x0400
#define VCF3_S_NamesFormat					11		/* Column has extended names format */
#define VCF3_M_NamesFormat					0x0800
#define VCF3_S_HideColumnTitle				12		/* Hide column title from display, but not from customization */
#define VCF3_M_HideColumnTitle				0x1000	
#define VCF3_S_IsSharedColumn				13
#define VCF3_M_IsSharedColumn				0x2000	/* Is this a shared column? */
#define VCF3_S_UseSharedColumnFormulaOnly	14
#define VCF3_M_UseSharedColumnFormulaOnly	0x4000 	/* Use only the formula from shared column - let use modify everything else */

	WORD	wHideWhenFormulaSize;
	WORD	wTwistieResourceSize;
	WORD    wCustomOrder;					/* V6 View Customization support */
	WORD	wCustomHiddenFlags;				/* V6 View Customization support */
#define	VCF_HIDE_S_NormalView 					0
#define	VCF_HIDE_M_NormalView 					0x0001
#define	VCF_HIDE_S_CalFormatTwoDay				1
#define	VCF_HIDE_M_CalFormatTwoDay				0x0002
#define	VCF_HIDE_S_CalFormatOneWeek 			2
#define	VCF_HIDE_M_CalFormatOneWeek				0x0004
#define	VCF_HIDE_S_CalFormatTwoWeeks 			3
#define	VCF_HIDE_M_CalFormatTwoWeeks			0x0008
#define	VCF_HIDE_S_CalFormatOneMonth 			4
#define	VCF_HIDE_M_CalFormatOneMonth			0x0010
#define	VCF_HIDE_S_CalFormatOneYear 			5
#define	VCF_HIDE_M_CalFormatOneYear				0x0020
#define	VCF_HIDE_S_CalFormatOneDay 				6
#define	VCF_HIDE_M_CalFormatOneDay				0x0040
#define	VCF_HIDE_S_CalFormatWorkWeek 			7
#define	VCF_HIDE_M_CalFormatWorkWeek			0x0080

/* For DB2 based NSFs the following flags are used to 
    remember the column mapping to DB2 Data types */
#define VCF_HIDE_S_DB2_MAPPING				8			/* Column mapped to DB2 data type  */
#define VCF_HIDE_M_DB2_MAPPING				  0x0100
#define VCF_HIDE_S_DB2_DATATYPE_TEXT		9			/* Column mapped to DB2 data type TEXT */
#define VCF_HIDE_M_DB2_DATATYPE_TEXT	 0x0200
#define VCF_HIDE_S_DB2_DATATYPE_NUMBER		10			/* Column mapped to DB2 data type  NUMBER */
#define VCF_HIDE_M_DB2_DATATYPE_NUMBER	 0x0400
#define VCF_HIDE_S_DB2_DATATYPE_TIMEDATE		11			/* Column mapped to DB2 data type TIMEDATE */
#define VCF_HIDE_M_DB2_DATATYPE_TIMEDATE	 0x0800
#define VCF_HIDE_S_DB2_DATATYPE_NONE			12			/* Select Column mapping to DB2 data type  */
#define VCF_HIDE_M_DB2_DATATYPE_NONE		 0x1000
/* #define	VCF_HIDE_S_spare 						13 - 15 */
/* #define	VCF_HIDE_M_spare						0x2000 - 0x8000 */

	COLOR_VALUE	ColumnColor;				/* V6 - Column Text Color */
	COLOR_VALUE HeaderFontColor;			/* V6 - column header color */
	} VIEW_COLUMN_FORMAT2;

typedef struct
	{
	WORD	Signature;								/* VIEW_COLUMN_FORMAT_SIGNATURE3 */
	/* Date/time formatting data */
	BYTE	DTPref;				/* NPREF_xxx */
	DWORD	DTFlags;			/* DT_xxx */
	DWORD	DTFlags2;			/* DT_xxx */
	BYTE	DTDOWFmt;			/* DT_WFMT_xxx */
	BYTE	DTYearFmt;			/* DT_YFMT_xxx */
	BYTE	DTMonthFmt;			/* DT_MFMT_xxx */
	BYTE	DTDayFmt;			/* DT_DFMT_xxx */
	BYTE	DTDsep1Len;
	BYTE	DTDsep2Len;
	BYTE	DTDsep3Len;
	BYTE	DTTsepLen;
	BYTE	DTDShow;			/* DT_DSHOW_xxx */
	BYTE	DTDSpecial;			/* DT_DSPEC_xxx */
	BYTE	DTTShow;			/* DT_TSHOW_xxx */
	BYTE	DTTZone;			/* TZFMT_xxx */
	WORD	DatePreference;
	BYTE	bUnused;
	DWORD	Unused;
	} VIEW_COLUMN_FORMAT3;

typedef VIEW_COLUMN_FORMAT3 *PVIEW_COLUMN_FORMAT3;

typedef struct
	{
	WORD	Signature;								/* VIEW_COLUMN_FORMAT_SIGNATURE4 */
	/* Numeric symbol data */
	NFMT	NumberFormat;
	BYTE	NumSymPref;			/* NPREF_xxx */
	BYTE	NumSymFlags;		/* NNUMSYM_xxx */
	DWORD	DecimalSymLength;
	DWORD	MilliSepSymLength;
	DWORD	NegativeSymLength;
	WORD	MilliGroupSize;
	DWORD	Unused1;
	DWORD	Unused2;
	/* Currency data */
	BYTE	CurrencyPref;		/* NPREF_xxx */
	BYTE	CurrencyType;		/* NCURFMT_xxx */
	BYTE	CurrencyFlags;		/* NCURFMT_xxx */
	DWORD	CurrencySymLength;
	DWORD	ISOCountry;
	WORD	NumberPreference;	
	BYTE	bUnused;
	DWORD	Unused3;
	DWORD	Unused4;
	} VIEW_COLUMN_FORMAT4;

typedef VIEW_COLUMN_FORMAT4 *PVIEW_COLUMN_FORMAT4;


typedef struct
	{
	WORD	Signature;								/* VIEW_COLUMN_FORMAT_SIGNATURE5 */
	WORD	dwLength;								/* sizeof this structure + any extra data. */
	/* Names style formatting data. */
	DWORD	dwFlags;						
#define VCF5_S_IS_NAME				0				/* Column contains a name. */
#define VCF5_M_IS_NAME				0x00000001
#define VCF5_S_SHOW_IM_STATUS		1				/* Show IM online status in this column. */
#define VCF5_M_SHOW_IM_STATUS		0x00000002
#define VCF5_S_VERT_ORIENT_TOP		2		  		/* vertically show the icon on top line. */
#define VCF5_M_VERT_ORIENT_TOP		0x00000004
#define VCF5_S_VERT_ORIENT_MID		3				/* vertically middle of the line entry */
#define VCF5_M_VERT_ORIENT_MID		0x00000008
#define VCF5_S_VERT_ORIENT_BOTTOM	4				/* show icon on the last line */
#define VCF5_M_VERT_ORIENT_BOTTOM	0x00000010

	WORD	wDistNameColLen;						/* Length of programatic name of column that contains distiguished name. */
	WORD	wSharedColumnAliasLen;					/* If shared column, length of the alias of the shared column */
	DWORD	dwReserved[4];							/* Reserved for future use. */
	} VIEW_COLUMN_FORMAT5;


#endif /* VIEWFMT_DEFS */


#ifdef __cplusplus
}
#endif


#if defined(OS400) && (__OS400_TGTVRM__ >= 510)
#pragma datamodel(pop)
#endif