summaryrefslogtreecommitdiffstats
path: root/scribus/plugins/short-words/parse.h
blob: 50d27569a90e1851ab2cb1fe4b175c2965874b17 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
/*
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 _SCRIBUS_SHORTPARSE_H_
#define _SCRIBUS_SHORTPARSE_H_

#include "shortwords.h"

#include <QObject>

class PageItem;

/*! \brief This is the Scribus Short Words plugin main mechanism.

It walks trough the user specified objects and apply the spaces.
This code is based on the Scribus-Vlna plug in rewritten for
international use.

\author Petr Vanek <petr@yarpen.cz> with contributors.
*/
class SWParse : public QObject
{
	Q_OBJECT

public:
	/*! \brief lightweight constructor */
	SWParse();
	/*! \brief nothing here to do */
	~SWParse(){};

	/*! \brief count of the changes (one frame = one change) */
	uint modify;

	//! language of the frame used
	QString lang;

	/*! \brief process one frame - base method!
	Replacing strings via regular expressions. See detailed
	description in the code of this method.
	\param aFrame pointer to the existing text frame */
	void parseItem(PageItem *aFrame);
	/*! \brief selcted frames on the page */
	void parseSelection(ScribusDoc* doc);
	/*! \brief one page - using actual page */
	void parsePage(ScribusDoc* doc);
	/*! \brief one page
	\param page page number*/
	void parsePage(ScribusDoc* doc, int page);
	/*! \brief all pages in the document */
	void parseAll(ScribusDoc* doc);
};

#endif