editods.h

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

#define CDTABLECELL_USE_BKGCOLOR	0x01	/* True if background color */
#define CDTABLECELL_USE_V42BORDERS	0x02	/* True if version 4.2 or after */
#define CDTABLECELL_INVISIBLEH		0x04	/* True if cell is spanned */
#define CDTABLECELL_INVISIBLEV		0x08	/* True if cell is spanned */
#define CDTABLECELL_USE_GRADIENT	0x10	/* True if gradient color */
#define CDTABLECELL_VALIGNCENTER	0x20	/* True if contents centered vertically */
#define CDTABLECELL_GRADIENT_LTR	0x40	/* True if gradient should go left to right */
#define CDTABLECELL_VALIGNBOTTOM	0x80	/* True if contents bottomed vertically */

	WORD v42Border;				/* wider borders */
#define	CDTC_S_V42_Left		0
#define	CDTC_M_V42_Left		0x000f
#define	CDTC_S_V42_Right	4
#define	CDTC_M_V42_Right	0x00f0
#define	CDTC_S_V42_Top		8
#define	CDTC_M_V42_Top		0x0f00
#define	CDTC_S_V42_Bottom	12
#define	CDTC_M_V42_Bottom	0xf000

	BYTE RowSpan;
	BYTE ColumnSpan;
	WORD BackgroundColor;			/* Color of background of cell */
	} CDTABLECELL;

/* more table cell flags stored via a CDTABLECELLDATAFLAGS record */
#define	CDTABLECELL_COLUMN_HEADER	0x00000001
#define	CDTABLECELL_ROW_HEADER		0x00000002


typedef struct
	{
	BSIG Header;
	DWORD Spare;
	} CDTABLEEND;

#define MAXREGIONNAME 35

typedef struct {
	WSIG Header;		/* Signature and length of this record */
	WORD Version;		
	WORD Flags;	  
	WORD RegionNum;
	char RegionName[MAXREGIONNAME+1];
} CDREGIONBEGIN;

typedef struct {
	WSIG Header;		/* Signature and length of this record */
	WORD RegionNum;
	char RegionName[MAXREGIONNAME+1];
} CDREGIONEND;

#define LARGEPARAGRAPH_VERSION1	0x0001
#define LARGEPARAGRAPH_CURRENT_VERSION	LARGEPARAGRAPH_VERSION1

typedef struct {
	WSIG Header;		/* Signature and length of this record */
	WORD Version;
	WORD Flags;		
#define CDLARGEPARAGRAPH_BEGIN	0x0001
#define CDLARGEPARAGRAPH_END	0x0002
	DWORD Spare[2];
} CDLARGEPARAGRAPH;

/*	CDFIELD - Field Reference Record, used in forms ($BODY) to define a field. */

typedef struct {
	WSIG Header;
	WORD Flags;					/* Field Flags (see Fxxx flags below) */
	WORD DataType;				/* Alleged NSF Data Type */
	WORD ListDelim;				/* List Delimiters (LDELIM_xxx and LDDELIM_xxx) */
	NFMT NumberFormat;			/* Number format, if applicable */	
	TFMT TimeFormat;			/* Time format, if applicable */
	FONTID FontID;				/* displayed font */
	WORD DVLength;				/* Default Value Formula */
	WORD ITLength;				/* Input Translation Formula */
	WORD TabOrder;				/* Order in tabbing sequence */
	WORD IVLength;				/* Input Validity Check Formula */
	WORD NameLength;			/* NSF Item Name */
	WORD DescLength;			/* Description of the item */
	WORD TextValueLength;		/* (Text List) List of valid text values */
								/* Now comes the variable part of the struct... */
} CDFIELD;

/*	CDFIELD List Delimeters (ListDelim) */

#define	LDELIM_SPACE		0x0001	/* low three nibbles contain delim flags */
#define	LDELIM_COMMA		0x0002
#define	LDELIM_SEMICOLON	0x0004
#define	LDELIM_NEWLINE		0x0008
#define	LDELIM_BLANKLINE	0x0010
#define	LD_MASK				0x0fff

#define	LDDELIM_SPACE		0x1000	/* high nibble contains the display type */
#define	LDDELIM_COMMA		0x2000
#define	LDDELIM_SEMICOLON	0x3000
#define	LDDELIM_NEWLINE		0x4000
#define	LDDELIM_BLANKLINE	0x5000
#define	LDD_MASK			0xf000

/*	CDFIELD Flags Definitions */

#define	V3SPARESTOCLEAR		0x0075	/* Clear these if FOCLEARSPARES is TRUE */

#define	FREADWRITERS		0x0001	/* Field contains read/writers */
#define	FEDITABLE			0x0002	/* Field is editable, not read only */
#define	FNAMES				0x0004	/* Field contains distinguished names */
#define	FSTOREDV			0x0008	/* Store DV, even if not spec'ed by user */
#define	FREADERS			0x0010	/* Field contains document readers */
#define FSECTION			0x0020	/* Field contains a section */
#define	FSPARE3				0x0040	/* can be assumed to be clear in memory, V3 & later */
#define	FV3FAB				0x0080	/* IF CLEAR, CLEAR AS ABOVE */
#define	FCOMPUTED			0x0100	/* Field is a computed field */
#define	FKEYWORDS			0x0200	/* Field is a keywords field */
#define	FPROTECTED			0x0400	/* Field is protected */
#define	FREFERENCE			0x0800	/* Field name is simply a reference to a shared field note */
#define	FSIGN				0x1000	/* sign field */
#define	FSEAL				0x2000	/* seal field */
#define	FKEYWORDS_UI_STANDARD		0x0000	/* standard UI */
#define	FKEYWORDS_UI_CHECKBOX		0x4000	/* checkbox UI */
#define	FKEYWORDS_UI_RADIOBUTTON	0x8000	/* radiobutton UI */
#define	FKEYWORDS_UI_ALLOW_NEW		0xc000	/* allow doc editor to add new values */

#define EC_FLAG_WIDTH_PROPORTIONAL	0x0001	/* field width proportional with font size (const # of chars) (height is part of flags2) */

/*	CDEXT2FIELD - Extended field reference record used for currency, numeric symbol, etc., information */

typedef struct {
	WSIG	Header;
	/* Numeric symbol data */
	BYTE	NumSymPref;			/* NPREF_xxx */
	BYTE	NumSymFlags;		/* NNUMSYM_xxx */
	DWORD	DecimalSymLength;
	DWORD	MilliSepSymLength;
	DWORD	NegativeSymLength;
	WORD	MilliGroupSize;
 	SWORD	VerticalSpacing;	/* extra vertical spacing (%) */
	SWORD	HorizontalSpacing;	/* extra horizontal spacing (%) */
	WORD	Unused2;
	WORD	FirstFieldLimitType;
	/* Currency data */
	BYTE	CurrencyPref;		/* NPREF_xxx */
	BYTE	CurrencyType;		/* NCURFMT_xxx */
	BYTE	CurrencyFlags;		/* NCURFMT_xxx */
	DWORD	CurrencySymLength;
	DWORD	ISOCountry;	
	DWORD	Unused3;
	DWORD	Unused4;
	/* 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 */
	DWORD	Unused5;
	/* Proportional font for fields data	*/

	BYTE	ECFlags;
	BYTE	Unused612;
	WORD	wCharacters;	/* Number of characters if proportional width	*/
	WORD	wInputEnabledLen;	/* Input enabled formula. */
	WORD	wIMGroupFormulaLen;	/* Instant messageing buddy list group name. */
							/* Now comes the variable part of the struct... */
} CDEXT2FIELD;

/*	CDEXTFIELD - Extended Field Reference Record, used in forms ($BODY) to define a field. */

typedef struct {
	WSIG Header;
	DWORD Flags1;				/* Field Flags (see FEXT_xxx flags below) */
	DWORD Flags2;
	WORD EntryHelper;			/* Field entry helper type (see FIELD_HELPER_XXX below) */
	WORD EntryDBNameLen;		/* Entry helper DB name length */
	WORD EntryViewNameLen;		/* Entry helper View name length */
	WORD EntryColumnNumber;		/* Entry helper column number */
								/* Now comes the variable part of the struct... */
} CDEXTFIELD;

/*	Flags for CDEXTFIELD Flags1.  Note that the low word in Flags1 is not used. */

#define FEXT_LOOKUP_EACHCHAR		0x00010000L	/* lookup name as each char typed */
#define FEXT_KWSELRECALC			0x00020000L	/* recalc on new keyword selection */
#define FEXT_KWHINKYMINKY			0x00040000L	/* suppress showing field hinky minky */
#define FEXT_AFTERVALIDATION		0x00080000L	/* recalc after validation */
#define FEXT_ACCEPT_CARET			0x00100000L	/* the first field with this bit set will accept the caret */
/*	These bits are in use by the	0x02000000L
	column value.  The result of	0x04000000L
	the shifted bits is (cols - 1)	0x08000000L */
#define FEXT_KEYWORD_COLS_SHIFT		25
#define FEXT_KEYWORD_COLS_MASK		0x0E000000L
#define FEXT_KEYWORD_FRAME_3D		0x00000000L
#define FEXT_KEYWORD_FRAME_STANDARD	0x10000000L
#define FEXT_KEYWORD_FRAME_NONE		0x20000000L
#define FEXT_KEYWORD_FRAME_MASK		0x30000000L
#define FEXT_KEYWORD_FRAME_SHIFT	28
#define FEXT_KEYWORDS_UI_COMBO		0x40000000L
#define FEXT_KEYWORDS_UI_LIST		0x80000000L

/*	Flags for CDEXTFIELD Flags2. */

#define FEXT_KW_CHOICE_RECALC		0x00000001 /* TRUE to recalc the value choices. */
#define FEXT_HTML_IN_FIELDDEF		0x00000002 /* TRUE means we have a CD_EXTHTML field */

#define FEXT_HIDEDELIMITERS			0x00000004 /* TRUE if hiding delimeters */
#define FEXT_KW_RTL_READING_ORDER	0x00000008
#define FEXT_ALLOWTABBINGOUT		0x00000010 /* TRUE if tab will exit field (used for richtext only) */
#define FEXT_PASSWORD				0x00000020 /* TRUE if field is a password field	*/
#define FEXT_USEAPPLETINBROWSER		0x00000040 /* TRUE if an applet should be used for a browser (richtext only)	*/
#define FEXT_CONTROL				0x00000080 /* TRUE if field is a control */

#define FEXT_LITERALIZE				0x00000100 /* TRUE if this is a formula
													field which should have 
													item substitution based on
													on items on the form.  This
													is the counterpart to a
													computed formula which is
													a formula programmatically
													generated through @formulas. */
#define FEXT_CONTROLDYNAMIC			0x00000200 /* TRUE if field is a dynamic control  */
#define FEXT_RUNEXITINGONCHANGE		0x00000400 /* TRUE if should run exiting event
												  when value changes.  Currently only
												  implemented for native date/time */
#define FEXT_TIMEZONE				0x00000800 /* TRUE if this is a time zone field */
#define FEXT_PROPORTIONALHEIGHT		0x00004000 /* TRUE if field has proportional height	*/
#define FEXT_PROPORTIONALWIDTH		0x00008000 /* TRUE if field has proportional width	*/
#define FEXT_SHOWIMSTATUS			0x02000000 /* TRUE if a names type field displays im online status */



/*	The following identifiers indicate the type of helper in use by the 
	Keyword and the Name helper/pickers */
/* these define the VarDataFlags signifying variable length data following struct */
#define	CDEXTFIELD_KEYWORDHELPER	0x0001
#define	CDEXTFIELD_NAMEHELPER		0x0002
#define 	FIELD_HELPER_NONE			0
#define 	FIELD_HELPER_ADDRDLG		1
#define 	FIELD_HELPER_ACLDLG			2
#define 	FIELD_HELPER_VIEWDLG		3
	
/*	(*** OBSOLETE ***) Pre-V1 Field Reference Record, used in Forms (*** OBSOLETE ***) */

typedef struct {
	WSIG Header;
	WORD Flags;					/* Field Flags */
	WORD DataType;				/* Alleged NSF Data Type */
	WORD ListDelim;				/* List Delimiters */
	NFMT NumberFormat;			/* Number format, if applicable */	
	TFMT TimeFormat;			/* Time format, if applicable */
	FONTID FontID;				/* displayed font */
	WORD DVLength;				/* Default Value Formula */
	WORD ITLength;				/* Input Translation Formula */
	WORD Unused1;				/* Unused */
	WORD IVLength;				/* Input Validity Check Formula */
	WORD NameLength;			/* NSF Item Name */
	WORD DescLength;			/* Description of the item */
								/* Now comes the variable part of the struct... */

} CDFIELD_PRE_36;				/* List of Text Values was added... */

#define FIELDHINT_LIMITED		0x0001

/*	CDFIELDHINT	 */
typedef struct {
	WSIG	Header;				/* Tag and length */
	WORD	HintTextLength;
	WORD	Flags;				/* See above */
	WORD	Spare;
	DWORD	Spare2;
								/* The 8-bit text string follows... */
} CDFIELDHINT;

/* CDDECSFIELD */
typedef struct {
	WSIG	Header;
	WORD	Flags;
	WORD	ExternalNameLength;
	WORD	MetadataNameLength;
	WORD	DCRNameLength;
	WORD	Spare[8];
} CDDECSFIELD;

#define FDECS_KEY_FIELD			0x0001
#define FDECS_STORE_LOCALLY	0x0002

/*	CDTEXT - 8-bit text string record */

typedef struct {
	WSIG	Header;				/* Tag and length */
	FONTID	FontID;				/* Font ID */
								/* The 8-bit text string follows... */
} CDTEXT;
typedef struct {
	WSIG	Header;				/* Tag and length */
	FONTID	FontEffectID;				/* Font ID */
} CDTEXTEFFECT;


#define LINK_VERSION1    0

/*	CDLINK2 - Link record */

typedef struct	{
	WSIG Header;
	WORD LinkID;				/* Index into array in $LINKS/$FORMLINKS field of this document */
								/* Now comes the display comment... */
} CDLINK2;


/*	CDLINKEXPORT - This record is used in the case of exporting
	a note to the clipboard, where the NSF item describing the links
	cannot be generated. */


typedef struct	{
	WSIG Header;
	NOTELINK NoteLink;
								/* Now comes the display comment... */
} CDLINKEXPORT2;


/*	CDKEYWORD - Keyword Record */

#define CDKEYWORD_RADIO				0x0001
/*	These bits are in use by the	0x0002
	column value.  The result of	0x0004
	the shifted bits is (cols - 1)	0x0008 */
#define CDKEYWORD_COLS_SHIFT		1
#define CDKEYWORD_COLS_MASK			0x000E
#define CDKEYWORD_FRAME_3D			0x0000