lnrt.hpp

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

//===========================================================================
//
// Module:	LNRT.HPP
//
// Description:
//
//	Class declarations of the LNRichText item classes, and the CD Record 
//	parsers.
//
//===========================================================================
//
// Copyright (c) 1996-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 LNRT_HPP
#define LNRT_HPP



#ifndef LNGLOBAL_H
#include "lnglobal.h"
#endif

#ifndef LNMBLOCK_HPP
#include "lnmblock.hpp"
#endif

#ifndef LNFONT_HPP
#include "lnfont.hpp"
#endif

#ifndef LNRTOBJ_HPP
#include "lnrtobj.hpp"
#endif

#ifndef LNFILE_HPP
#include "lnfile.hpp"
#endif

#ifndef IXPORT_H
#define IXPORT_H


#include <ixedit.h>
#include <ixport.h>
#include <osenv.h>
#include <ossignal.h>
#include <oserr.h>
#endif


#include "lndb.hpp"




class LNIMPEXPCL LNRichText : public LNItem
{

public:

	LNRichText();
	LNRichText(const LNString &text);
	LNRichText(const LNItem &item);
	LNRichText(const LNRichText &richtext);
	
	~LNRichText();
	
	LNRichText& operator=(const LNItem &item);
	LNRichText& operator=(const LNRichText &richtext);

	LNRichText& operator<<(const LNString &text);
	LNRichText& operator<<(const LNRichText &richtext);
	LNRichText& operator<<(const LNRTObject &object);

	LNSTATUS Append(const LNString &text, LNBOOL convertNewLines = FALSE);
	LNSTATUS Append(const LNRichText &richtext);
	LNSTATUS Append(const LNRTObject &object, LNRTObject *newObject = 0);
	LNSTATUS Append(const LNRTObject &object, LNBOOL addParagraph, 
		LNRTObject *newObject = 0);

	LNSTATUS AppendRenderedDocument(LNDocument &doc);
	LNSTATUS AppendRenderedDocument(LNDocument &doc, const LNString &form);
	LNSTATUS AppendRenderedDocument(LNDocument &doc, LNForm &form);

	LNSTATUS ClearHotspot(LNHotspot *hotspot);

	LNSTATUS CreateActionHotspot(const LNFormula &formula, LNRTCursor *start,
		LNRTCursor *end, LNActionHotspot *newHotspot = 0);
	LNSTATUS CreateActionHotspot(const LNLotusScript &script, LNRTCursor *start,
		LNRTCursor *end, LNActionHotspot *newHotspot = 0);
	LNSTATUS CreateActionHotspot(const LNSimpleAction &action, LNRTCursor *start,
		LNRTCursor *end, LNActionHotspot *newHotspot = 0);
	LNSTATUS CreateActionHotspot(const LNSimpleActions &actions, LNRTCursor *start,
		LNRTCursor *end, LNActionHotspot *newHotspot = 0);

	LNSTATUS CreateAnchorLink(const LNViewFolder &view, 
		const LNAnchorLocation &loc, LNRTCursor *cursor, 
		LNAnchorLink *newLink = 0);
	LNSTATUS CreateAnchorLink(const LNViewFolder &view, 
		const LNDocument &document, const LNString &anchorText, 
		LNRTCursor *cursor, LNAnchorLink *newLink = 0);
	LNSTATUS CreateAnchorLink(const LNAnchorLocation &loc, LNRTCursor *cursor, 
		LNAnchorLink *newLink = 0);
	LNSTATUS CreateAnchorLink(const LNDocument &document, const LNString &anchorText, 
		LNRTCursor *cursor, LNAnchorLink *newLink = 0);
	LNSTATUS CreateAnchorLink(const TIMEDATE DBreplicaID, 
		const UNID *viewUNID, const UNID *noteUNID, 
		const LNString &description, const LNString &anchorText, 
		const LNNotesSession *session, LNRTCursor *cursor, 
		LNAnchorLink *newLink = 0);

	LNSTATUS CreateAnchorLocation(const LNString &anchorText, 
		LNRTCursor *cursor, LNAnchorLocation *newAnchorLocation = 0);

	LNSTATUS CreateAttachment(const LNString &path, LNRTCursor *cursor, 
		LNRTAttachment *newrtattachment ) const;
	LNSTATUS CreateAttachment(const LNString &path,  LNRTCursor *cursor, 
		const LNString &attachmentname = "", LNBOOL compress = TRUE, 
		LNRTAttachment *newrtattachment = 0 ) const;
	LNSTATUS CreateAttachment(const LNRTAttachment &rtatt, 
		LNRTCursor *cursor, LNRTAttachment *newrtattachment = 0 ) const;
	LNSTATUS CreateAttachment(const LNAttachment &att, LNRTCursor *cursor, 
		LNRTAttachment *newrtattachment = 0 ) const;

    LNSTATUS CreateButton(const LNString &label, const LNFormula &formula, 
		LNRTCursor *cursor, LNButton *newButton = 0);
	LNSTATUS CreateButton(const LNString &label, const LNSimpleAction &action, 
		LNRTCursor *cursor, LNButton *newButton = 0);
	LNSTATUS CreateButton(const LNString &label, const LNSimpleActions &actions, 
		LNRTCursor *cursor, LNButton *newButton = 0);
	LNSTATUS CreateButton(const LNString &label, const LNLotusScript &script, 
		LNRTCursor *cursor, LNButton *newButton = 0);

	LNSTATUS CreateComputedText(const LNFormula &formula, LNRTCursor *cursor,
		LNComputedText *computedText = 0);

	LNSTATUS CreateControlledSection(const LNString &title, 
		LNRTCursor *start, LNRTCursor *end, LNSection *newSection = 0);

	LNSTATUS CreateDatabaseLink(const LNDatabase &db, LNRTCursor *cursor, 
		LNDatabaseLink *newLink = 0);
	LNSTATUS CreateDatabaseLink(const TIMEDATE DBreplicaID, 
		const LNString &description, const LNNotesSession *session, 
		LNRTCursor *cursor, LNDatabaseLink *newLink = 0);

	LNSTATUS CreateDocumentLink(const LNViewFolder &view, 
		const LNDocument &document, LNRTCursor *cursor, 
		LNDocumentLink *newLink = 0);
	LNSTATUS CreateDocumentLink(const LNDocument &document, LNRTCursor *cursor, 
		LNDocumentLink *newLink = 0);
	LNSTATUS CreateDocumentLink(const TIMEDATE DBreplicaID, 
		const UNID *viewUNID, const UNID *noteUNID, const LNString &desc, 
		const LNNotesSession *session, LNRTCursor *cursor, 
		LNDocumentLink *newLink = 0);

	LNSTATUS CreateFormField(const LNString &name, LNRTTYPE type, 
		LNRTCursor *cursor, LNFormField *newField = 0);

	LNSTATUS CreateFormulaPopup(const LNFormula &formula, LNRTCursor *start, 
		LNRTCursor *end, LNFormulaPopup *newPopup = 0);

	LNSTATUS CreateHorizontalRule(const LNNUMBER width, const LNNUMBER height, 
		LNRTCursor *end, LNHorizontalRule *rule = 0);

	LNSTATUS CreateJavaApplet (const LNString & baseClassName,
		LNRTCursor * cursor, LNRTJavaApplet * newApplet = 0);
	LNSTATUS CreateJavaApplet (const LNString & baseClassName,
		const LNString & alternateText, const LNString & appletFile,
		const LNString & appletPath, LNRTCursor * cursor,
		LNRTJavaApplet * newApplet = 0);
	LNSTATUS CreateJavaApplet (const LNString & baseClassName,
		const LNString & alternateText, const LNText & appletFileList,
		const LNString & appletPath, LNRTCursor * cursor,
		LNRTJavaApplet * newApplet = 0);

	LNSTATUS CreateLayoutRegion (LNRTCursor * cursor, LNLayout * newLayout = 0);

	LNSTATUS CreateLinkHotspot(const LNDatabaseLink &link, LNRTCursor *start, 
		LNRTCursor *end, LNLinkHotspot *newLink = 0);

	LNSTATUS CreateLinkHotspot(const LNNamedElement &namedelement, LNRTCursor *start, 
		LNRTCursor *end, LNLinkHotspot *newLink = 0);

	LNSTATUS CreateOLEObject(const LNString &path, const LNOLEGUID &guid,
		LNOLECLIPBOARDFORMAT displayFormat, const LNString &progID,
        const LNString &userType, LNRTCursor *cursor,
		const LNString &attachmentName = "", LNRTOLEObject *pNewObject = 0) const;
	LNSTATUS CreateOLEObject(const LNRTOLEObject &rtObj, LNRTCursor *cursor,
		LNRTOLEObject *pNewObject = 0) const;
	LNSTATUS CreateOLEObject(const LNOLEObject &oleObj,
		LNOLECLIPBOARDFORMAT displayFormat, const LNString & progID,
		LNRTCursor *cursor, LNRTOLEObject *pNewObject = 0) const;

	LNSTATUS CreateRTComputedSubform(const LNFormula &formula, 
		LNRTCursor *cursor, LNRTComputedSubform *newObject = 0);
	LNSTATUS CreateRTSubform(const LNString &subformname, 
		LNRTCursor *cursor, LNRTSubform *newObject = 0);
	LNSTATUS CreateRTSubform(const LNSubform &subform, 
		LNRTCursor *cursor, LNRTSubform *newObject = 0);

	LNSTATUS CreateStringSection(const LNString &title, LNRTCursor *start, 
		LNRTCursor *end, LNSection *newSection = 0);
	LNSTATUS CreateFormulaSection(const LNFormula &title, LNRTCursor *start, 
		LNRTCursor *end, LNSection *newSection = 0);
    LNSTATUS CreateSection(LNRTCursor *start, LNRTCursor *end,
		LNSection *newSection = 0)
		{ return CreateStringSection("", start, end, newSection); }

	LNSTATUS CreateTable(LNINT rows, LNINT cols, LNRTCursor *cursor, 
		LNTable *newTable = 0);

	LNSTATUS CreateTextPopup(const LNString &popupText, LNRTCursor *start, 
		LNRTCursor *end, LNTextPopup *newPopup = 0);

    LNSTATUS CreateURLLink(const LNString &URL, LNRTCursor *start, 
		LNRTCursor *end, LNURLLink *newLink = 0);

	LNSTATUS CreateURLLinkFormula(const LNFormula &urlFormula, LNRTCursor *start, 
	LNRTCursor *end, LNURLLink *newLink = 0);

	LNSTATUS CreateViewLink(const LNDatabase &db, const LNViewFolder &view, 
		LNRTCursor *cursor, LNViewLink *newLink = 0);
	LNSTATUS CreateViewLink(const TIMEDATE DBreplicaID, const UNID *viewUNID, 
		const LNString &description, const LNNotesSession *session, 
		LNRTCursor *cursor, LNViewLink *newLink = 0);

	LNSTATUS Delete(LNRTCursor *start, LNRTCursor *end);
	LNSTATUS Delete(LNRTCursor *start, LNINT poscount);
	LNSTATUS Delete(LNRTObject *object);

	LNSTATUS DeleteAttachment(const LNString& name, LNBOOL del = TRUE);
	LNSTATUS DeleteAttachment(const LNAttachment *att, LNBOOL del = TRUE);

	LNSTATUS DeleteFormField(const LNString &name);

	LNSTATUS DeleteOLEObject(const LNString &name, LNBOOL del = TRUE);
	LNSTATUS DeleteOLEObject(LNRTOLEObject &rtObj, LNBOOL del = TRUE);

	LNSTATUS DeleteRTSubform(const LNString &name);
	
    LNSTATUS Export(const LNString &filename, const LNRTCursor &start, 
		const LNRTCursor &end,const LNString &exporttype = "");
    LNSTATUS Export(const LNString &filename, const LNString &exportdll, 
		const LNRTCursor &start, const LNRTCursor &end, 
		const LNString &altlib = "");    

	LNSTATUS GetAttachment(const LNString& name, LNRTAttachment *att) const;

	virtual LNCLASSID GetClassID() const { return LNCLASSID_LNRICHTEXT; }
	
	LNSTATUS GetCursor(LNRTCursor *cursor) const;					 

	LNSTATUS GetEndCursor(LNRTCursor *cursor) const;					 

	LNSTATUS GetFontStyle(const LNRTCursor &cursor, LNFontStyle *style) const;

	LNSTATUS GetFormField(const LNString &name, LNFormField *field) const;

	LNSTATUS GetOLEObject(const LNString &name, LNRTOLEObject *rtObj) const;

	LNBOOL GetPageBreakBefore(const LNRTCursor &cursor);

	LNSTATUS GetParagraphStyle(const LNRTCursor &cursor, 
		LNParagraphStyle *style) const;

	LNSTATUS GetRichText(const LNRTCursor &start, const LNRTCursor &end,
		LNRichText *richtext) const;