Branch 1.3.5 tree to 1.4.x tree, goodbye 1.3.x

git-svn-id: svn://scribus.net/branches/Version14x/Scribus@17163 11d20701-8431-0410-a711-e3c959e3b870

1 files changed, 121 insertions, 0 deletions

diff --git a/scribus/sampleitem.h b/scribus/sampleitem.h
new file mode 100644
index 0000000..3e950d6
--- /dev/null
+++ b/scribus/sampleitem.h
@@ -0,0 +1,121 @@
+/*
+For general Scribus (>=1.3.2) copyright and licensing information please refer
+to the COPYING file provided with the program. Following this notice may exist
+a copyright and/or license notice that predates the release of Scribus 1.3.2
+for which a new license (GPL+exception) is in place.
+*/
+#ifndef SAMPLEITEM_H
+#define SAMPLEITEM_H
+
+#include <QObject>
+#include <QPixmap>
+#include "scribusapi.h"
+#include "scribusstructs.h"
+
+class QString;
+class QColor;
+class ScribusDoc;
+
+
+/*! \brief Provides sample "text frame" as pixmap.
+You can create a pixmap with standard Scribus text frame
+here. It can be used as a kind of preview.
+It needs at least one existing ScribusDoc - so there
+is one created if ScWM->doc is null (then it's destroyed
+of course).
+SampleItem creates 2 temporary colors in scribus document -
+Black and white - to be sure to display B/W preview correctly
+every time. These color are renoved in descructor. Or used
+cleanupTemporary() method.
+\warning Be sure there will be called destructor or cleanupTemporary()
+at the end of work with it!
+\author Petr Vanek <petr@yarpen.cz>
+*/
+class SCRIBUS_API SampleItem : QObject
+{
+	Q_OBJECT
+
+	public:
+		SampleItem(ScribusDoc* doc);
+		~SampleItem();
+
+		/*! \brief Set sample text.
+		\param aText QString to set. */
+		void setText(QString aText);
+		/*! \brief Use lorem ipsum generator as text source.
+		\param para count of the LI paragraphs */
+		void setLoremIpsum(int para);
+		/*! \brief Set backgroud color of the pixmap.
+		\param c a QColor */
+		void setBgColor(QColor c);
+		void setBgShade(int c);
+		/*! \brief Set color management for backgroud color of the pixmap.
+		\param enable if color management should be enabled */
+		void setBgColorMngt(bool enable);
+		/*! \brief Set Text color of the pixmap.
+		\param c a QColor */
+		void setTxColor(QColor c);
+		void setTxShade(int c);
+
+		/*! \brief Set whole Scribus paragraph style in one.
+		\param aStyle Paragraph style to set.*/
+		void setStyle(const ParagraphStyle& aStyle);
+		/*! \brief Folowing methods set only one style characteristic */
+		void setLineSpaMode(int lineSpaMode);
+		void setLineSpa(double lineSpa);
+		void setTextAlignment(int textAlignment);
+		void setIndent(double indent);
+		void setRightMargin(double indent);
+		void setFirst(double first);
+		void setGapBefore(double gapBefore);
+		void setGapAfter(double gapAfter);
+		void setFont(QString font);
+		/*! \brief Set size of the font.
+		\param fontSize fontSize * 10.0 usually
+		\param autoLineSpa if true - use automatic line spacing computing */
+		void setFontSize(int fontSize, bool autoLineSpa=false);
+		//void setTabValues(QValueList<PageItem::TabRecord> tabValues);
+		void setDrop(bool drop);
+		void setDropLin(int dropLin);
+		void setDropDist(double dropDist);
+		void setFontEffect(int fontEffect);
+		void setFColor(QString fColor);
+		void setFShade(int fShade);
+		void setSColor(QString sColor);
+		void setSShade(int sShade);
+		void setBaseAdj(bool baseAdj);
+		void setTxtShadowX(int txtShadowX);
+		void setTxtShadowY(int txtShadowY);
+		void setTxtOutline(int txtOutline);
+		void setTxtUnderPos(int txtUnderPos);
+		void setTxtUnderWidth(int txtUnderWidth);
+		void setTxtStrikePos(int txtStrikePos);
+		void setTxtStrikeWidth(int txtStrikeWidth);
+		void setScaleH(int scaleH);
+		void setScaleV(int scaleV);
+		void setBaseOff(int baseOff);
+		void setKernVal(int kernVal);
+
+		/*! \brief Get the sample.
+		\param width W of the sample
+		\param height H of the sample
+		\retval QPixmap rendered image
+		*/
+		QPixmap getSample(int width, int height);
+		/*! \brief Remove the tmp issues. */
+		void cleanupTemporary();
+
+	private:
+		//! \brief Text to be rendered
+		QString text;
+		//! \brief Internal temporary paragraph style
+		ParagraphStyle tmpStyle;
+		/*! \brief Reference to a document.
+		Existing or created one */
+		ScribusDoc *m_Doc;
+		//! \brief Is the doc created used only? true = used
+		bool used;
+		int bgShade;
+};
+
+#endif