lnenums.h

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

enum LNNUMBERFORMAT
{
	LNNUMBERFORMAT_GENERAL = NFMT_GENERAL,
	LNNUMBERFORMAT_FIXED = NFMT_FIXED,
	LNNUMBERFORMAT_SCIENTIFIC = NFMT_SCIENTIFIC,
	LNNUMBERFORMAT_CURRENCY = NFMT_CURRENCY
};

// TTFMT_FULL_MAX ordinarilly defined in MISC.H but placed here to accomodate S390 changes 7/01

#ifndef TTFMT_FULL_MAX
#define TTFMT_FULL_MAX 3
#endif

enum LNTIMEFORMAT
{
	LNTIMEFORMAT_HOUR = TTFMT_HOUR,
	LNTIMEFORMAT_HOUR_MINUTE = TTFMT_PARTIAL,
	LNTIMEFORMAT_HOUR_MINUTE_SECOND = TTFMT_FULL,
	LNTIMEFORMAT_HOUR_MINUTE_SECOND_HUNDREDTHS = TTFMT_FULL_MAX
};

enum LNTIMEZONE
{
	LNTIMEZONE_GMT = 0,
	LNTIMEZONE_ZW1 = 1,
	LNTIMEZONE_ZW2 = 2,
	LNTIMEZONE_ZW3 = 3,
	LNTIMEZONE_NST = 3003,
	LNTIMEZONE_AST = 4,
	LNTIMEZONE_EST = 5,
	LNTIMEZONE_CST = 6,
	LNTIMEZONE_MST = 7,
	LNTIMEZONE_PST = 8,
	LNTIMEZONE_YST = 9,
	LNTIMEZONE_ZW9B = 3009,
	LNTIMEZONE_HST = 10,
	LNTIMEZONE_BST = 11,
	LNTIMEZONE_ZW12 = 12,
	LNTIMEZONE_ZE12C = -4512,
	LNTIMEZONE_ZE12 = -12,
	LNTIMEZONE_ZE11B = -3011,
	LNTIMEZONE_ZE11 = -11,
	LNTIMEZONE_ZE10B = -3010,
	LNTIMEZONE_ZE10 = -10,
	LNTIMEZONE_ZE9B = -3009,
	LNTIMEZONE_ZE9 = -9,
	LNTIMEZONE_ZE8 = -8,
	LNTIMEZONE_ZE7 = -7,
	LNTIMEZONE_ZE6B = -3006,
	LNTIMEZONE_ZE6 = -6,
	LNTIMEZONE_ZE5C = -4505,
	LNTIMEZONE_ZE5B = -3005,
	LNTIMEZONE_ZE5 = -5,
	LNTIMEZONE_ZE4B = -3004,
	LNTIMEZONE_ZE4 = -4,
	LNTIMEZONE_ZE3B = -3003,
	LNTIMEZONE_ZE3 = -3,
	LNTIMEZONE_ZE2 = -2,
	LNTIMEZONE_CET = -1
};

enum LNTIMEZONEDISPLAY
{
	LNTIMEZONEDISPLAY_ADJUST_TO_LOCAL = TZFMT_NEVER,
	LNTIMEZONEDISPLAY_SHOW_ALWAYS = TZFMT_ALWAYS,
	LNTIMEZONEDISPLAY_SHOW_IF_NOT_LOCAL = TZFMT_SOMETIMES
};
	
// LNSTRINGCOMPAREFLAGS: flags used by global LNStringCompare functions.

typedef DWORD LNSTRINGCOMPAREFLAGS;

#define LNSTRINGCOMPAREFLAGS_MATCH_ACCENT	INTL_ACCENT_SENSITIVE
#define LNSTRINGCOMPAREFLAGS_MATCH_CASE		INTL_CASE_SENSITIVE
#define LNSTRINGCOMPAREFLAGS_DEFAULT		0

// LNVFSHARINGOPTION: view/folder sharing option (shared or private)

enum LNVFSHARINGOPTION
{
	LNVFSHARINGOPTION_SHARED,
	LNVFSHARINGOPTION_PRIVATE,
	LNVFSHARINGOPTION_PRIVATE_ON_FIRST_USE,
	LNVFSHARINGOPTION_PRIVATE_ON_FIRST_USE_IN_DESKTOP,

	// The next two and the typedef below are for backwards compatibility.
	LNVFSHARING_SHARED		= LNVFSHARINGOPTION_SHARED,
	LNVFSHARING_PERSONAL	= LNVFSHARINGOPTION_PRIVATE
};

typedef LNVFSHARINGOPTION LNVFSHARING;

// LNVFTYPE: view/folder type (view or folder)

enum LNVFTYPE
{
	LNVFTYPE_VIEW,
	LNVFTYPE_FOLDER
};

// LNENCRYPTOPTION: encryption option for LNDatabase::CreateEncryptedNote

enum LNENCRYPTOPTION
{
	LNENCRYPTOPTION_PRIVATE	= 0,
	LNENCRYPTOPTION_PUBLIC	= ENCRYPT_WITH_USER_PUBLIC_KEY
};

// Pointers to OLE interfaces

typedef void *	LNILockBytes;
typedef void *	LNIStorage;

// OLE GUID or CLSID

typedef struct 
{
    DWORD Data1;
    WORD  Data2;
    WORD  Data3;
    BYTE  Data4[8];
} LNOLEGUID;

// LNOLECLIPBOARDFORMAT: data formats for LNOLEObject and LNRTOLEObject

enum LNOLECLIPBOARDFORMAT
{
	LNOLECLIPBOARDFORMAT_TEXT		= DDEFORMAT_TEXT,
	LNOLECLIPBOARDFORMAT_METAFILE	= DDEFORMAT_METAFILE,
	LNOLECLIPBOARDFORMAT_BITMAP		= DDEFORMAT_BITMAP,
	LNOLECLIPBOARDFORMAT_RICHTEXT	= DDEFORMAT_RTF,
	LNOLECLIPBOARDFORMAT_ICON		= DDEFORMAT_ICON
};

// LNFORMTYPE: defines the type of a form. Used in LNForm class.

enum LNFORMTYPE
{
	LNFORMTYPE_DOCUMENT				= 0,	// Document
	LNFORMTYPE_RESPONSE,					// Response to topic.
	LNFORMTYPE_RESPONSE_TO_RESPONSE			// Response to response.	
};

// LNINCLUDEINMENUOPTION: defines where in the create menu a choice to 
// create a note will be put and how the choice will be displayed.  Used
// in LNForm class.

enum LNINCLUDEINMENUOPTION
{
	LNINCLUDEINMENUOPTION_CREATE		= 0,	// include a menu choice in the Create menu
	LNINCLUDEINMENUOPTION_CREATE_OTHER,			// include a choice in the Create - Other - Dialog box
	LNINCLUDEINMENUOPTION_NONE					// no menu or dialog choices for this form
};

// LNVERSIONINGOPTION: defines the versioning options for documents created using a form.

enum LNVERSIONINGOPTION
{
	LNVERSIONINGOPTION_NONE		= 0,						// No versioning options.
	LNVERSIONINGOPTION_RESPONSE	= TPL_FLAG_UPDATE_RESPONSE,	// New versions become responses.
	LNVERSIONINGOPTION_PARENT	= TPL_FLAG_UPDATE_PARENT,	// Prior versions become responses.
	LNVERSIONINGOPTION_SIBLING	= TPL_FLAG_UPDATE_SIBLING	// New versions become siblings
};

// LNCONTEXTPANEOPTION: defines the type of context pane specified in a form.

enum LNCONTEXTPANEOPTION
{
	LNCONTEXTPANEOPTION_NONE	= 0,	// No context pane specified in this form.
	LNCONTEXTPANEOPTION_DOCLINK,		
	LNCONTEXTPANEOPTION_PARENT		
};

// LNINHERITDOCOPTION: defines whether a document will be stored
// in a rich text field of a newly created document and the 
// storage method to use.

enum LNINHERITDOCOPTION
{
	LNINHERITDOCOPTION_NONE					= 0,	// Document will not be stored.
	LNINHERITDOCOPTION_RICH_TEXT,					// Stored as rich text.
	LNINHERITDOCOPTION_COLLAPSIBLE_RICH_TEXT,		// Stored as collapsible rich text,
	LNINHERITDOCOPTION_LINK							// Stored as link
};

// LNAUTOLAUNCHOBJECTTYPE: defines a form's auto launch object type for 
// documents that use the form.

enum LNAUTOLAUNCHOBJECTTYPE
{
	LNAUTOLAUNCHOBJECTTYPE_NONE			= AUTOLAUNCH_OBJTYPE_NONE,		// No auto launch options specified
	LNAUTOLAUNCHOBJECTTYPE_ATTACHMENT	= AUTOLAUNCH_OBJTYPE_ATTACH,	// Launches the first attachment
	LNAUTOLAUNCHOBJECTTYPE_DOCLINK		= AUTOLAUNCH_OBJTYPE_DOCLINK,	// Launches the first Doclink
	LNAUTOLAUNCHOBJECTTYPE_OLE_OBJECT	= AUTOLAUNCH_OBJTYPE_OLEOBJ,	// Launches the first OLE object
	LNAUTOLAUNCHOBJECTTYPE_OLE_CLASS	= AUTOLAUNCH_OBJTYPE_OLE_CLASS,	// OLE Class ID (GUID)
	LNAUTOLAUNCHOBJECTTYPE_URL			= AUTOLAUNCH_OBJTYPE_URL		// Launches the url in the URL field
};

// LNCREATEOBJECTINFIELDOPTION: When an object is autolaunched, modified by the user, and saved,
// it is copied to and displayed in the document in the field specified by this option.

enum LNCREATEOBJECTINFIELDOPTION
{
	LNCREATEOBJECTINFIELDOPTION_NONE 			= FIELD_COPY_NONE,	// Don't copy or display the object to any field.
	LNCREATEOBJECTINFIELDOPTION_FIRST_RT_FIELD	= FIELD_COPY_FIRST,	// Displays the object in the first rich text field.
	LNCREATEOBJECTINFIELDOPTION_NAMED_RT_FIELD	= FIELD_COPY_NAMED	// Use the RT field name specified by an LNString. 
};

// LNLAUNCHOBJECTWHENFLAGS: Flags used by the auto launch feature in forms
// to determine when an object, contained in a document will autolaunch.

typedef DWORD LNLAUNCHOBJECTWHENFLAGS;

#define LNLAUNCHOBJECTWHENFLAGS_CREATING	LAUNCH_WHEN_CREATE
#define LNLAUNCHOBJECTWHENFLAGS_EDITING		HIDE_OPEN_EDIT
#define LNLAUNCHOBJECTWHENFLAGS_READING		LAUNCH_WHEN_READ

// LNHIDEDOCUMENTWHENFLAGS: Flags used by the auto launch feature in 
// forms to determine when to hide the notes document. 

typedef DWORD LNHIDEDOCUMENTWHENFLAGS;

#define LNHIDEDOCUMENTWHENFLAGS_OPEN_CREATING	HIDE_OPEN_CREATE
#define LNHIDEDOCUMENTWHENFLAGS_OPEN_EDITING	HIDE_OPEN_EDIT
#define LNHIDEDOCUMENTWHENFLAGS_OPEN_READING	HIDE_OPEN_READ
#define LNHIDEDOCUMENTWHENFLAGS_CLOSE_CREATING	HIDE_CLOSE_CREATE
#define LNHIDEDOCUMENTWHENFLAGS_CLOSE_EDITING	HIDE_CLOSE_EDIT
#define LNHIDEDOCUMENTWHENFLAGS_CLOSE_READING	HIDE_CLOSE_READ

//	LNATTACHMENTTYPE: type of data stored in an attachment.

enum LNATTACHMENTTYPE
{
	LNATTACHMENTTYPE_DOS				= HOST_MSDOS,
	LNATTACHMENTTYPE_OLE				= HOST_OLE,
	LNATTACHMENTTYPE_MAC				= HOST_MAC,
	LNATTACHMENTTYPE_UNKNOWN			= HOST_UNKNOWN,
	LNATTACHMENTTYPE_HPFS				= HOST_HPFS,
	LNATTACHMENTTYPE_OLELIB				= HOST_OLELIB,
	LNATTACHMENTTYPE_BYTEARRAY_EXTENT	= HOST_BYTEARRAY_EXT,
	LNATTACHMENTTYPE_BYTEARRAY_PAGE		= HOST_BYTEARRAY_PAGE,
	LNATTACHMENTTYPE_CD_STORAGE			= HOST_CDSTORAGE,
	LNATTACHMENTTYPE_STREAM				= HOST_STREAM,
	LNATTACHMENTTYPE_RESOURCE_LINK		= HOST_LINK
};

//	LNACTIONTYPE:  type of action performed by a button, action hotspot, agent, or action

enum LNACTIONTYPE
{
	LNACTIONTYPE_UNKNOWN = 0,
	LNACTIONTYPE_FORMULA,
	LNACTIONTYPE_LOTUSSCRIPT,
	LNACTIONTYPE_SIMPLE_ACTIONS,
	LNACTIONTYPE_COMMAND,
	LNACTIONTYPE_JAVA,
	LNACTIONTYPE_JAVASCRIPT
};

//	LNSCRIPTLIBRARYTYPE:  type of the script library

enum LNSCRIPTLIBRARYTYPE
{
	LNSCRIPTLIBRARYTYPE_UNKNOWN = 0,
	LNSCRIPTLIBRARYTYPE_LOTUSSCRIPT,
	LNSCRIPTLIBRARYTYPE_JAVA
};

//  Base types of frameset
enum LNFRAMESETBASETYPE
{
	LNFRAMESETBASETYPE_DEFAULT = 0,
	LNFRAMESETBASETYPE_L = LNFRAMESETBASETYPE_DEFAULT,
	LNFRAMESETBASETYPE_R,	
	LNFRAMESETBASETYPE_T,
	LNFRAMESETBASETYPE_B,
	LNFRAMESETBASETYPE_LR,//
	LNFRAMESETBASETYPE_TB,//
	LNFRAMESETBASETYPE_LT,
	LNFRAMESETBASETYPE_TL,
	LNFRAMESETBASETYPE_LB,
	LNFRAMESETBASETYPE_BL,//
	LNFRAMESETBASETYPE_RB,
	LNFRAMESETBASETYPE_BR,//
	LNFRAMESETBASETYPE_RTB,
	LNFRAMESETBASETYPE_LTB,
	LNFRAMESETBASETYPE_TLB,
	LNFRAMESETBASETYPE_TBL
};


// LNCHARSET: specifies input character set for LNStringTranslate

enum LNCHARSET
{
	LNCHARSET_UNICODE,
	LNCHARSET_UTF8
};

// LNUNITS:	identifies the units of user input and output values. Generally,
//			Notes data is stored in TWIPS.

enum LNUNITS
{
	LNUNITS_INCHES,
	LNUNITS_CENTIMETERS,
	LNUNITS_TWIPS,
	LNUNITS_DEFAULT
};


enum LNNOTEDELETEFLAGS
{
    LNNOTEDELETEFLAGS_FORCE     = UPDATE_FORCE,
    LNNOTEDELETEFLAGS_NOCOMMIT  = UPDATE_NOCOMMIT,
    LNNOTEDELETEFLAGS_NOSTUB    = UPDATE_NOSTUB
};

// LNCOLOR: representation of an 8-bit color value. LNCOLOR_xxx values map
//			the first 0-15 Notes color values. Notes allows 240 total 8-bit
//			values. The LNColor class supports RGB colors added in Notes 5.0.

typedef WORD LNCOLOR;

#define LNCOLOR_BLACK 			NOTES_COLOR_BLACK
#define LNCOLOR_WHITE			NOTES_COLOR_WHITE
#define LNCOLOR_RED				NOTES_COLOR_RED
#define LNCOLOR_GREEN			NOTES_COLOR_GREEN
#define LNCOLOR_BLUE			NOTES_COLOR_BLUE
#define LNCOLOR_MAGENTA			NOTES_COLOR_MAGENTA
#define LNCOLOR_YELLOW			NOTES_COLOR_YELLOW
#define LNCOLOR_CYAN			NOTES_COLOR_CYAN
#define LNCOLOR_DARK_RED		NOTES_COLOR_DKRED
#define LNCOLOR_DARK_GREEN		NOTES_COLOR_DKGREEN
#define LNCOLOR_DARK_BLUE		NOTES_COLOR_DKBLUE
#define LNCOLOR_DARK_MAGENTA	NOTES_COLOR_DKMAGENTA
#define LNCOLOR_DARK_YELLOW		NOTES_COLOR_DKYELLOW
#define LNCOLOR_DARK_CYAN		NOTES_COLOR_DKCYAN
#define LNCOLOR_GRAY			NOTES_COLOR_GRAY
#define LNCOLOR_LIGHT_GRAY		NOTES_COLOR_LTGRAY

//
//	Position constants
//

typedef enum
{
	LNPOSITION_NONE = 0,
	LNPOSITION_LEFT,
	LNPOSITION_CENTER,
	LNPOSITION_RIGHT
} LNPOSITION;


#endif	// LNENUMS_H