lnrttabl.hpp

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

	virtual void ValidateRTType(const LNRTObjectBody *other) const;
};



class LNIMPEXPCL LNTable : public LNRTContainer
{

public:
	LNSTATUS SetLeftMarginPercent(LNINT leftMargin);
	LNNUMBER GetRightMargin();
	LNSTATUS SetRightMarginPercent(LNINT rightMargin);
	LNSTATUS SetRightMargin(const LNNUMBER &rightMargin);

	LNTable();	

	~LNTable();
	
	LNTable(const LNRTObject &object);
	LNTable(const LNTable &table);
	LNTable(LNINT rows, LNINT cols);

	LNTable& operator=(const LNRTObject &object);
	LNTable& operator=(const LNTable &table);

	//	Returns the specified table cell object. 
	//	The row and column are zero-based, where (0,0) is the top left table cell.
	LNTableCell operator() (LNINT row, LNINT column);

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

	LNSTATUS AppendColumns(LNINT count);

	//	Appends one or more columns or rows to the table. 
	//	The optional parameter is the number of columns/rows to append.
	LNSTATUS AppendRows(LNINT count);

	LNSTATUS DeleteColumns(LNINT column, LNINT count = 1);
	
	//	Deletes one or more columns or rows and their data from the table, 
	//	starting with the specified column/row. The first parameter is the 
	//	zero-based column/row number. The second optional parameter is the 
	//	number of columns/rows to delete.
	LNSTATUS DeleteRows(LNINT row, LNINT count = 1);

	LNColor GetAlternateColor () const;

	//	Returns TRUE if the table width is automatically computed by 
	//	Notes (if the table size is automatically fit to the window size).
	LNBOOL GetAutomaticWidth() const;

	LNTABLEBORDERSTYLE GetBorderStyle() const
		{ return GetCellBorderStyle(); }

	LNINT GetBottomBorderWidth() const;
	LNINT GetLeftBorderWidth() const;
	LNINT GetRightBorderWidth() const;
	LNINT GetTopBorderWidth() const;

	LNINT GetBottomInsideBorderWidth() const;
	LNINT GetLeftInsideBorderWidth() const;
	LNINT GetRightInsideBorderWidth() const;
	LNINT GetTopInsideBorderWidth() const;

	LNINT GetBottomOutsideBorderWidth() const;
	LNINT GetLeftOutsideBorderWidth() const;
	LNINT GetRightOutsideBorderWidth() const;
	LNINT GetTopOutsideBorderWidth() const;

	LNSTATUS GetCDTableBegin(CDTABLEBEGIN *tablebegin) const;

	LNSTATUS GetCDTableEnd(CDTABLEEND *tableend) const;

	LNColor GetCellBorderColor () const;

	LNCELLBORDERSTYLE GetCellBorderStyle() const;

	virtual LNCLASSID GetClassID() const { return LNCLASSID_LNTABLE; }

	LNColor GetColor () const;

	LNTABLECOLORSTYLE GetColorStyle () const;

	LNINT GetColumnCount() const;
	
	LNNUMBER GetColumnSpacing(); 
	
 	//	The first parameter is the zero-based column number. The optional second 
	//	parameter specifies the units of measurement. See LNUNITS () for more information.
	LNNUMBER GetColumnWidth(LNINT column);

	LNBOOL GetDropShadow() const;

	LNINT GetDropShadowWidth() const;

	LNSTATUS GetHTMLTags (LNHTMLTags * pTags) const;

	LNBOOL GetIsColumnWidthFixed(const LNINT column) const;

	//	Returns the left margin setting in the specified units.  
	//	See LNUNITS () for more information.
	LNNUMBER GetLeftMargin();
	
	LNNUMBER GetMinimumRowHeight() const;
	
	LNINT GetRowCount() const;

	LNTABLEROWDISPLAY GetRowDisplay (void) const;

	LNString GetRowName ( const LNINT row) const;

	LNSTATUS GetRowSelectionFormula (LNFormula * pFormula) const;
	LNSTATUS GetRowSelectionString (LNString * pString) const;

	LNNUMBER GetRowSpacing();

	LNString GetRowTabLabel (LNINT row) const;

	LNINT GetRowTimeInterval () const;

	LNBOOL GetRTLReadingOrder() const;

	LNColor GetTableBorderColor() const;

	LNTABLEBORDERSTYLE GetTableBorderStyle() const;

	LNString GetTableName (void) const;

	LNUNITS	GetUnits() const;

	LNBOOL GetUseR4Spacing() const;

	LNTABLEWIDTHTYPE GetWidthType() const;

	LNBOOL GetWrapTextAroundTable() const;

	LNBOOL GetWrapTextBetweenCells() const;

	LNNUMBER GetWrapTextBetweenCellsHeight() const;

	LNSTATUS InsertColumns(LNINT column, LNINT count = 1);
	
	//	Inserts one or more columns or rows in the table, before the specified column/row. 
	//	The first parameter is the zero-based column/row number. The optional 
	//	second parameter is the number of columns/rows to insert.
	LNSTATUS InsertRows(LNINT row, LNINT count = 1);

	LNBOOL IsRowSelectionString (void) const;
	LNBOOL IsRowSelectionFormula (void) const;

	LNSTATUS MergeCells (LNINT row1, LNINT col1, LNINT row2, LNINT col2);
	LNSTATUS MergeCells (LNTableCell &cell1, LNTableCell &cell2);

	LNSTATUS Outline(LNCELLBORDERTYPE style);
	LNSTATUS Outline(LNCELLBORDERSTYLE style = LNCELLBORDERSTYLE_SOLID);

	LNSTATUS SetAllBorderWidths( LNINT width );
	LNSTATUS SetBottomBorderWidth( LNINT width );
	LNSTATUS SetLeftBorderWidth( LNINT width );
	LNSTATUS SetRightBorderWidth( LNINT width );
	LNSTATUS SetTopBorderWidth( LNINT width );

	LNSTATUS SetAllInsideBorderWidths( LNINT width );
	LNSTATUS SetBottomInsideBorderWidth( LNINT width );
	LNSTATUS SetLeftInsideBorderWidth( LNINT width );
	LNSTATUS SetRightInsideBorderWidth( LNINT width );
	LNSTATUS SetTopInsideBorderWidth( LNINT width );

	LNSTATUS SetAllOutsideBorderWidths( LNINT width );
	LNSTATUS SetBottomOutsideBorderWidth( LNINT width );
	LNSTATUS SetLeftOutsideBorderWidth( LNINT width );
	LNSTATUS SetRightOutsideBorderWidth( LNINT width );
	LNSTATUS SetTopOutsideBorderWidth( LNINT width );

	LNSTATUS SetAlternateColor (const LNColor & color);

	//	Modifies automatic width computation flag.  TRUE fits the table to the window size.
	LNSTATUS SetAutomaticWidth(const LNBOOL flag);
	
	LNSTATUS SetBackgroundColor(const LNColor & color);

	LNSTATUS SetBorderStyle(LNTABLEBORDERSTYLE newStyle)
		{ return SetCellBorderStyle(newStyle); }

	LNSTATUS SetCellBorderColor (const LNColor & color);

	LNSTATUS SetCellBorderStyle(LNCELLBORDERSTYLE newStyle);

	LNSTATUS SetColor (const LNColor & color);

	LNSTATUS SetColorStyle (LNTABLECOLORSTYLE style);

	LNSTATUS SetColumnSpacing(const LNNUMBER &spacing);
	
	//	The first parameter is the zero-based column number. The second parameter is the new width. 
	//	If automatic width is set, this function does nothing and returns a warning.
	LNSTATUS SetColumnWidth(LNINT column, const LNNUMBER &width);

	void SetDropShadow( LNBOOL flag );

	LNSTATUS SetDropShadowWidth( LNINT width );

	LNSTATUS SetHTMLTags (const LNHTMLTags & tags);

	LNSTATUS SetIsColumnWidthFixed(const LNINT column, const LNBOOL newFlag);
	
	//	Modifies the left margin setting. The first parameter is the new margin. 
	//	This function returns an error if the specified margin is out of range.
	LNSTATUS SetLeftMargin(const LNNUMBER &margin);
	
	LNSTATUS SetMinimumRowHeight( const LNNUMBER &height );

	LNSTATUS SetRowDisplay ( const LNTABLEROWDISPLAY type);
	
	LNSTATUS SetRowName ( const LNINT row, const LNString name);
	
	LNSTATUS SetRowSelectionString ( const LNString & rowTag );
	LNSTATUS SetRowSelectionFormula ( const LNFormula & rowFormula );

	//	Gets or Sets the spacing between columns in the specified units., 
	//	as defined by LNUITS enum.
	LNSTATUS SetRowSpacing(const LNNUMBER &spacing);

	LNSTATUS SetRowTabLabel (const LNINT row, const LNString &label);

	LNSTATUS SetRowTimeInterval (LNINT interval);
	
	LNSTATUS SetRTLReadingOrder(LNBOOL rtl = TRUE);

	LNSTATUS SetTableBorderColor( const LNColor &color );

	LNSTATUS SetTableBorderStyle( LNTABLEBORDERSTYLE style );

	LNSTATUS SetTableName ( const LNString & name );

	//	Turns off the background color in every table cell in this table. 
	//	This function is only supported for Notes versions 4.5 and later.
	LNSTATUS SetTransparent(const LNBOOL newFlag = TRUE);

	void SetUnits(const LNUNITS units);

	void SetUseR4Spacing( LNBOOL flag );

	LNSTATUS SetWidthType( LNTABLEWIDTHTYPE type );

	void SetWrapTextAroundTable( LNBOOL flag );

	void SetWrapTextBetweenCells( LNBOOL flag );

	LNSTATUS SetWrapTextBetweenCellsHeight( const LNNUMBER &height );

	LNSTATUS SplitCells (LNINT row1, LNINT col1, LNINT row2, LNINT col2);
	LNSTATUS SplitCells (LNTableCell &cell1, LNTableCell &cell2);

protected:

	LNTable(LNTableBody *body);

	LNTable& operator=(LNTableBody *body);

	LNTableBody* GetTableBody() const; 

	virtual void ValidateRTType(const LNRTObject &other) const;
	virtual void ValidateRTType(const LNRTObjectBody *other) const;

private:

	LNNUMBER Convert(LNINT twips) const;
	LNINT Convert(const LNNUMBER &number) const;
};

#endif