koffice/filters/kspread/latex/export/format.h

/*
** Header file for inclusion with kword_xml2latex.c
**
** Copyright (C) 2002 Robert JACOLIN
**
** This library is free software; you can redistribute it and/or
** modify it under the terms of the GNU Library General Public
** License as published by the Free Software Foundation; either
** version 2 of the License, or (at your option) any later version.
**
** This library is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
** Library General Public License for more details.
**
** To receive a copy of the GNU Library General Public License, write to the
** Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
**
*/

#ifndef __KSPREAD_LATEX_FORMAT_H__
#define __KSPREAD_LATEX_FORMAT_H__

#include <tqtextstream.h>
#include <tqstring.h>
#include <tqcolor.h>
#include "xmlparser.h"
#include "pen.h"

/***********************************************************************/
/* Class: Format                                                       */
/***********************************************************************/

class Column;
class Row;

/**
 * This class describe a cell, row or column format.
 */
class Format: public XmlParser
{
	long _align;
	long _alignY;
	TQColor _bgColor;
	long _multirow;
	bool _verticalText;
	double _angle;
	TQColor _brushColor;
	int _brushStyle;
	int _indent;
	bool _dontprinttext;

	/* pen */
	double _penWidth;
	int _penStyle;
	TQColor _penColor;

	/* font */
	int _size;
	TQString _family;
	int _weight;

	/* borders */
	Pen *_bottomBorder;
	Pen *_topBorder;
	Pen *_leftBorder;
	Pen *_rightBorder;
	
	/* */
	bool _isValidFormat;

	public:
		/**
		 * Constructors
		 *
		 * Creates a new instance of Format.
		 *
		 * @param Para the parent class of the format.
		 */
		Format();

		/* 
		 * Destructor
		 *
		 * Nothing to do
		 */
		virtual ~Format();

		/**
		 * getters
		 */
		long getMultirow() const { return _multirow; }
		long getAlign() const { return _align; }
		long getAlignY() const { return _alignY; }
		TQColor getBgColor() const { return _bgColor; }
		bool getVerticalText() const { return _verticalText; }
		double getAngle() const { return _angle; }
		TQColor getBrushColor() const { return _brushColor; }
		int getBrushStyle() const { return _brushStyle; }
		int getIndent() const { return _indent; }
		bool getDontPrintText() const { return _dontprinttext; }
	
		bool hasBorder() const { return (hasTopBorder() || hasBottomBorder() || hasLeftBorder() || hasRightBorder()); }
		bool hasTopBorder() const;
		//Pen* getTopBorder() const { return _topBorder; }
		bool hasBottomBorder() const;
		//Pen* getBottomBorder() const { return _bottomBorder; }
		bool hasLeftBorder() const;
		//Pen* getLeftBorder() const { return _leftBorder; }
		bool hasRightBorder() const;
		//Pen* getRightBorder() const { return _rightBorder; }
		
		/* pen */
		double getPenWidth() const { return _penWidth; }
		int getPenStyle()    const { return _penStyle; }
		TQColor getPenColor() const { return _penColor; }
		
		/* font */
		int getFontSize() const { return _size; }
		TQString getFontFamily() const { return _family; }
		int getFontWeight() const { return _weight; }
		bool isValidFormat() const { return _isValidFormat; }

		/**
		 * setters
		 */
		void setAlign(long a) { _align = a; }
		void setAlignY(long a) { _alignY = a; }
		void setBgColor(TQColor b) { _bgColor = b; }
		void setMultirow(long mr)  { _multirow = mr; }
		void setVerticalText(bool vt) { _verticalText = vt; }
		void setAngle(double a) { _angle = a; }
		void setBrushColor(TQString bc) { _brushColor.setNamedColor(bc); }
		void setBrushStyle(int bs) { _brushStyle = bs; }
		void setIndent(int indent) { _indent = indent; }
		void setDontPrintText(bool dpt) { _dontprinttext = dpt; }

		/* pen */
		void setPenWidth(double pw) { _penWidth = pw; }
		void setPenStyle(int ps)    { _penStyle = ps; }
		void setPenColor(TQString pc) { _penColor.setNamedColor(pc); }

		/* font */
		void setFontSize(int s) { _size = s; }
		void setFontFamily(TQString f) { _family = f; }
		void setFontWeight(int w) { _weight = w; }

		/**
		 * Helpfull functions
		 */

		/**
		 * Get informations from a markup tree (only param of a format).
		 */
		virtual void analyse(const TQDomNode);
		virtual void analysePen(const TQDomNode);
		virtual void analyseFont(const TQDomNode);

		/**
		 * Generate the cell format inherited from the row or the colum format or
		 * use its own format.
		 *
		 * @param out The output stream.
		 * @param col The column of this cell.
		 * @param row The row of this cell.
		 */
		void generate(TQTextStream& out, Column* col = NULL, Row* row = NULL);

		/**
		 * Generate the text cell format (color and font).
		 */
		void generateTextFormat(TQTextStream& out, TQString text);

		/**
		 * Generate the color format for a column or a row.
		 *
		 * The command can be either columncolor or rowcolor.
		 * 
		 * @param out The output stream
		 */
		void generateColor(TQTextStream& out);
};

#endif /* __KSPREAD_LATEX_FORMAT_H__ */