lnaction.hpp

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

//===========================================================================
//
// Module:  LNACTION.HPP
//
// Description:
//
//		Class library definition for LNActions, LNAction, and related classes.
//
//===========================================================================
//
// Copyright (c) 1998-2004 Lotus Development Corporation. All rights reserved.
// This software is subject to the Lotus Software Agreement, Restricted
// Rights for U.S. government users, and applicable export regulations.
//
//===========================================================================

#ifndef LNACTION_HPP
#define LNACTION_HPP


//Declarations from actprop.h - not exposed yet (7/5/2000) in the
//C API
#ifndef ACTION_SET_3D_ONMOUSEOVER
#define ACTION_SET_3D_ONMOUSEOVER		0
#endif

#ifndef ACTION_SET_3D_ALWAYS
#define ACTION_SET_3D_ALWAYS			1
#endif

#ifndef ACTION_SET_3D_NEVER
#define ACTION_SET_3D_NEVER				2
#endif

//===========================================================================
//
//		Data types and constants
//
//===========================================================================

// Command codes for system actions
enum LNACTIONCOMMAND
{
	LNACTIONCOMMAND_UNKNOWN = 0,
	LNACTIONCOMMAND_CATEGORIZE = 1,
	LNACTIONCOMMAND_EDIT_DOCUMENT = 2,
	LNACTIONCOMMAND_SEND_DOCUMENT = 3,
	LNACTIONCOMMAND_FORWARD = 4,
	LNACTIONCOMMAND_MOVE_TO_FOLDER = 5,
	LNACTIONCOMMAND_REMOVE_FROM_FOLDER = 6
};

	// Action bar line styles
enum LNACTIONBARLINESTYLE
{
	LNACTIONBARLINESTYLE_UNKNOWN = 0,
	LNACTIONBARLINESTYLE_NARROW,
	LNACTIONBARLINESTYLE_MEDIUM,
	LNACTIONBARLINESTYLE_WIDE,
	LNACTIONBARLINESTYLE_DOUBLE
};

	// Action bar line types
enum LNACTIONBARLINETYPE
{
	LNACTIONBARLINETYPE_NONE,
	LNACTIONBARLINETYPE_FIT_TO_WINDOW,
	LNACTIONBARLINETYPE_UNDER_BUTTONS,
	LNACTIONBARLINETYPE_FIXED_LENGTH
};

enum LNACTIONIMAGETYPE
{
	LNACTIONIMAGETYPE_NONE,
	LNACTIONIMAGETYPE_NOTES,
	LNACTIONIMAGETYPE_CUSTOM,
	LNACTIONIMAGETYPE_FORMULA
};

enum LNACTIONBARBTNBORDERDISPLAYOPTION
{
	LNACTIONBARBTNBORDERDISPLAYOPTION_ONMOUSEOVER = ACTION_SET_3D_ONMOUSEOVER,
	LNACTIONBARBTNBORDERDISPLAYOPTION_ALWAYS = ACTION_SET_3D_ALWAYS,
	LNACTIONBARBTNBORDERDISPLAYOPTION_NEVER = ACTION_SET_3D_NEVER
};

enum LNACTIONBARBTNHEIGHTOPTION
{
	LNACTIONBARBTNHEIGHTOPTION_DEFAULT, // Clear flags
	LNACTIONBARBTNHEIGHTOPTION_MINIMUM, //ACTION_BAR_FLAG_SET_HEIGHT
	LNACTIONBARBTNHEIGHTOPTION_FIXED, // ACTION_BAR_FLAG_SET_HEIGHT | ACTION_BAR_FLAG_ABSOLUTE_HEIGHT
	LNACTIONBARBTNHEIGHTOPTION_BACKGROUND // ACTION_BAR_FLAG_SET_HEIGHT | ACTION_BAR_FLAG_BACKGROUND_HEIGHT
};

enum LNACTIONBARBTNWIDTHOPTION
{
	LNACTIONBARBTNWIDTHOPTION_DEFAULT, // Clear flags
	LNACTIONBARBTNWIDTHOPTION_BACKGROUND // ACTION_BAR_FLAG_SET_WIDTHOPTION | ACTION_BAR_FLAG_BACKGROUND_WIDTHOPTION
};

enum LNACTIONBARBTNMARGINOPTION
{
	LNACTIONBARBTNMARGINOPTION_DEFAULT, // Clear flags
	LNACTIONBARBTNMARGINOPTION_FIXED // ACTION_BAR_FLAG_SET_PADDING
};
/* bitwise flags for the dwFlags field */

#define ACTION_BAR_FLAG_NO_SYS_COLOR	0x00000001
#define ACTION_BAR_FLAG_ALIGN_RIGHT		0x00000002		/* Right justify buttons */
#define ACTION_BAR_FLAG_TRANS_BUTTONS	0x00000004		/* Buttons are transparent */
#define ACTION_BAR_FLAG_SYS_BUTTONS		0x00000008		/* Buttons use system color */
#define ACTION_BAR_FLAG_BTNBCK_IMGRSRC	0x00000010		/* Image resource used for button background */
#define ACTION_BAR_FLAG_BARBCK_IMGRSRC	0x00000020		/* Image resource used for bar background */
#define ACTION_BAR_FLAG_SET_PADDING		0x00000040		/* Use the Padding setting instead of default 2 pixels */
#define ACTION_BAR_FLAG_USE_APPLET		0x00000080		/* Use applet in browser */
#define ACTION_BAR_FLAG_SET_HEIGHT			0x00000100	/* Use Height setting instead of default ICON_DEFAULT_HEIGHT */
#define ACTION_BAR_FLAG_ABSOLUTE_HEIGHT		0x00000200	/* if ACTION_BAR_FLAG_SET_HEIGHT, use absolute height spec'd by user */
#define ACTION_BAR_FLAG_BACKGROUND_HEIGHT	0x00000400	/* if ACTION_BAR_FLAG_SET_HEIGHT, use background image's height */
#define ACTION_BAR_FLAG_SET_WIDTH			0x00000800	/* Use Width setting instead of default width */
#define ACTION_BAR_FLAG_BACKGROUND_WIDTH	0x00001000	/* if ACTION_BAR_FLAG_SET_WIDTH, use background image's width */

	
//===========================================================================
//
//		Class definition for LNAction
//
//===========================================================================

class LNIMPEXPCL LNAction : public LNSmartPtr
{
	public:
		LNAction (void);
		LNAction (const LNAction & other);

		LNAction (const LNString &title, const LNLotusScript &script);
		LNAction (const LNString &title, const LNSimpleAction & action);
		LNAction (const LNString &title, const LNSimpleActions & actions);
		LNAction (const LNString &title, const LNFormula &formula);
		LNAction (const LNString &title, const LNJavaScript &javascript);

		~LNAction (void);

		LNAction &		operator= (const LNAction & other);

		LNACTIONTYPE	GetActionType (void) const;
		LNACTIONIMAGETYPE GetActionImageType (void) const;

		LNCLASSID		GetClassID (void) const
							{ return (LNCLASSID_LNACTION); }

		LNBOOL			GetCloseOLEObject (void) const;

		LNACTIONCOMMAND	GetCommand (void) const;
		LNSTATUS		GetFormula (LNFormula * pFormula) const;
		LNSTATUS		GetJavaScript (LNJavaScript * pJavaScript) const;
		
		LNBOOL			GetHideFromNotes (void) const;
		LNBOOL			GetHideFromWeb (void) const;
		
		LNSTATUS		GetHideIfFormula( LNFormula *formula ) const;
		LNBOOL			GetHideIfFormulaEnabled (void) const;
		
		LNFormula		GetImageFormula (void) const;
		LNString		GetImageName (void) const;
		LNINT			GetIconIndex (void) const;

		LNSTATUS		GetLotusScript (LNLotusScript * pScript) const;
		
		LNBOOL			GetOLEWindowToFront (void) const;
		LNBOOL			GetPublishWithOLE (void) const;
		LNBOOL			GetRightAlignButton (void) const;
		LNBOOL			GetRightAlignImage (void) const;
		LNINT           GetSharedActionID() const;
		LNBOOL			GetShowIconOnly (void) const;
		LNBOOL			GetShowInButtonBar (void) const;
		LNBOOL			GetShowInMenu (void) const;
		LNBOOL			GetShowWhenEditing (void) const;
		LNBOOL			GetShowWhenEditingPreview (void) const;
		LNBOOL			GetShowWhenPreviewing (void) const;
		LNBOOL			GetShowWhenReading (void) const;
		
		LNSTATUS		GetSimpleActions (LNSimpleActions * pActions) const;

		LNINT			GetSize () const;

		LNString		GetTargetName (void) const;
		LNString		GetTitle (void) const;

		LNBOOL			HasHideIfFormula(void) const;
		
		LNBOOL          IsShared() const;

		void			SetCloseOLEObject (LNBOOL newFlag);

		LNSTATUS		SetCommand (LNACTIONCOMMAND newCommand);

		LNSTATUS		SetFormula (const LNFormula & newFormula);
		LNSTATUS		SetJavaScript (const LNJavaScript & newJavaScript);

		void			SetHideFromNotes (LNBOOL newFlag);
		void			SetHideFromWeb (LNBOOL newFlag);

		LNSTATUS		SetHideIfFormula( const LNFormula &formula );
		LNSTATUS		SetHideIfFormulaEnabled (LNBOOL newFlag);
		
		LNSTATUS        SetImageFormula (const LNFormula &imageFormula);
		LNSTATUS        SetImageName (const LNString &imageName);
		LNSTATUS		SetIconIndex (LNINT newIcon);

		LNSTATUS		SetLotusScript (const LNLotusScript & newScript);

		void			SetOLEWindowToFront (LNBOOL newFlag);
		void			SetPublishWithOLE (LNBOOL newFlag);
		void			SetRightAlignButton (LNBOOL newFlag);
		void			SetRightAlignImage (LNBOOL newFlag);
		LNSTATUS        SetSharedActionID(LNINT sharedActionID);
		void			SetShowIconOnly (LNBOOL newFlag);
		void			SetShowInButtonBar (LNBOOL newFlag);
		void			SetShowInMenu (LNBOOL newFlag);
		void			SetShowWhenEditing (LNBOOL newFlag);
		void			SetShowWhenEditingPreview (LNBOOL newFlag);
		void			SetShowWhenPreviewing (LNBOOL newFlag);
		void			SetShowWhenReading (LNBOOL newFlag);

		LNSTATUS		SetSimpleAction (const LNSimpleAction & newAction);
		LNSTATUS		SetSimpleActions (const LNSimpleActions & newActions);

		LNSTATUS		SetTargetName(const LNString &newName);
		LNSTATUS		SetTitle (const LNString &newTitle);

	protected:
		LNAction (LNActionBody * pBody);

	private:
		virtual LNSTATUS	Copy (const LNAction & other);
		LNActionBody *	GetActionBody (void) const;
		LNSTATUS		PrepareToModify (LNBOOL createBody);
};

//===========================================================================
//
//		Class definition for LNActions
//
//===========================================================================

class LNIMPEXPCL LNActions : public LNItem
{

	public:
		LNActions (void);
		LNActions (const LNItem & other);
		LNActions (const LNActions & other);
		LNActions (const LNNote & note);

		~LNActions (void);

		LNActions &			operator= (const LNItem & other);
		LNActions &			operator= (const LNActions & other);

		LNAction &			operator[] (LNINT n);

		LNSTATUS			Append (const LNAction & newAction);
		LNSTATUS			Delete (LNINT index, LNINT count = 1);

		LNColor				GetActionBarBackgroundColor (void) const;
        LNFormula           GetActionBarButtonBackgroundImageFormula(void) const;
		LNString            GetActionBarButtonBackgroundImageName(void) const;
		LNACTIONBARBTNBORDERDISPLAYOPTION GetActionBarButtonBorderDisplayOption(void) const;
		LNColor				GetActionBarButtonColor (void) const;
		LNINT               GetActionBarButtonHeight() const;
		LNACTIONBARBTNHEIGHTOPTION	GetActionBarButtonHeightOption(void) const;
		LNINT               GetActionBarButtonMargin(void) const;
		LNACTIONBARBTNMARGINOPTION	GetActionBarButtonMarginOption(void) const;
		LNACTIONBARBTNWIDTHOPTION	GetActionBarButtonWidthOption(void) const;
		LNFontStyle			GetActionBarFontStyle (void) const;
		LNColor				GetActionBarFontColor (void) const;
		LNColor				GetActionBarLineColor (void) const;
		LNINT				GetActionBarLineLength (void) const;
		LNACTIONBARLINESTYLE	GetActionBarLineStyle (void) const;
		LNACTIONBARLINETYPE	GetActionBarLineType (void) const;
		LNBOOL				GetActionBarUseSystemColor (void) const;

		virtual LNCLASSID	GetClassID (void) const
								{ return (LNCLASSID_LNACTIONS); }
		LNINT				GetCount (void) const;
		LNINT				GetLastSharedActionID() const;

		LNSTATUS			Insert (LNINT position, const LNAction & newAction);
        LNBOOL				IsActionBarButtonBackgroundImageFormula(void) const;

		LNSTATUS			SetActionBarBackgroundColor (const LNColor &newColor);
        LNSTATUS			SetActionBarButtonBackgroundImageFormula(const LNFormula &formula);
		LNSTATUS            SetActionBarButtonBackgroundImageName(const LNString &imagename);
		LNSTATUS			SetActionBarButtonBorderDisplayOption(LNACTIONBARBTNBORDERDISPLAYOPTION newOption);
		LNSTATUS			SetActionBarButtonColor(const LNColor &newColor);
		LNSTATUS            SetActionBarButtonHeight(LNINT height);
		LNSTATUS			SetActionBarButtonHeightOption(LNACTIONBARBTNHEIGHTOPTION newOption);
		LNSTATUS			SetActionBarButtonMarginOption(LNACTIONBARBTNMARGINOPTION newOption);
		LNSTATUS            SetActionBarButtonMargin(LNINT margin);
		LNSTATUS	        SetActionBarButtonWidthOption(LNACTIONBARBTNWIDTHOPTION newOption);
		LNSTATUS			SetActionBarFontStyle(const LNFontStyle &newFont);
		LNSTATUS			SetActionBarFontColor(const LNColor &newColor);
		LNSTATUS			SetActionBarLineColor (const LNColor &newColor);
		LNSTATUS			SetActionBarLineLength (LNINT newLength);
		LNSTATUS			SetActionBarLineStyle (LNACTIONBARLINESTYLE newStyle);
		LNSTATUS			SetActionBarLineType (LNACTIONBARLINETYPE newType);
		LNSTATUS			SetActionBarUseSystemColor (LNBOOL newFlag);
		LNSTATUS			SetLastSharedActionID(LNINT lastSharedActionID);

private:
		LNActions (LNNoteBody * noteb, LNActionsBody * itemb) :
			LNItem(noteb, (LNItemBody *) itemb) {}
		LNActionsBody * GetActionsBody (void) const;

		LNActions &			operator= (LNActionsBody * pBody);

		LNINT			GetSize () const;
		LNSTATUS		Load (LNNoteBody * pNote, LNBOOL createDefaults);
		LNSTATUS		PrepareToModify (LNBOOL createBody);
		LNSTATUS		SetNewActions (LNNoteBody * pNoteBody) const;
};

#endif