Inheritance diagram for PageAPI:

Collaboration diagram for PageAPI:

Public Slots
void	remove ()

QObject *	newRectangle (double x, double y, double width, double height)

QObject *	newEllipse (double x, double y, double width, double height)

QObject *	newImage (double x, double y, double width, double height)

QObject *	newText (double x, double y, double width, double height)

QObject *	newLine (double x, double y, double width, double height)

void	placeSVG (const QString &filename, const double x, const double y)

void	placeODG (const QString &filename, const double x, const double y)

void	placeEPS (const QString &filename, const double x, const double y)

void	placeSXD (const QString &filename, const double x, const double y)

void	savePageAsEPS (const QString &filename)

Public Member Functions
	PageAPI (ScPage *thisPage)

Properties
int	number

int	position

QList< QVariant >	items

QList< QVariant >	selection

int	type

Member Function Documentation

QObject * PageAPI::newEllipse	(	double	x,
		double	y,
		double	width,
		double	height
	)

slot

Scripter.activeDocument.activePage.newEllipse(x, y, width, height) x is a double y is a double width is a double height is a double returns Item object

QObject * PageAPI::newImage	(	double	x,
		double	y,
		double	width,
		double	height
	)

slot

Scripter.activeDocument.activePage.newImage(x, y, width, height) x is a double y is a double width is a double height is a double returns Item object

QObject * PageAPI::newLine	(	double	x,
		double	y,
		double	width,
		double	height
	)

slot

Scripter.activeDocument.activePage.newLine(x, y, width, height) x is a double y is a double width is a double height is a double returns Item object

QObject * PageAPI::newRectangle	(	double	x,
		double	y,
		double	width,
		double	height
	)

slot

Scripter.activeDocument.activePage.newRectangle(x, y, width, height) x is a double y is a double width is a double height is a double returns Item object

QObject * PageAPI::newText	(	double	x,
		double	y,
		double	width,
		double	height
	)

slot

Scripter.activeDocument.activePage.newText(x, y, width, height) x is a double y is a double width is a double height is a double returns Item object

void PageAPI::placeEPS	(	const QString &	filename,
		const double	x,
		const double	y
	)

slot

Scripter.activeDocument.activePage.placeEPS(filename x, y) filename is string x is double y is double import vector graphics at given position on active page

void PageAPI::placeODG	(	const QString &	filename,
		const double	x,
		const double	y
	)

slot

Scripter.activeDocument.activePage.placeODG(filename x, y) filename is string x is double y is double import vector graphics at given position on active page

void PageAPI::placeSVG	(	const QString &	filename,
		const double	x,
		const double	y
	)

slot

Scripter.activeDocument.activePage.placeSVG(filename x, y) filename is string x is double y is double import vector graphics at given position on active page

void PageAPI::placeSXD	(	const QString &	filename,
		const double	x,
		const double	y
	)

slot

Scripter.activeDocument.activePage.placeSXD(filename x, y) filename is string x is double y is double import vector graphics at given position on active page

void PageAPI::remove ( )

slot

Scripter.activeDocument.activePage.remove()

Removes the active page from the active document.

void PageAPI::savePageAsEPS ( const QString & filename )

slot

Scripter.activeDocument.activePage.savePageAsEPS(filename) filename is QString

Property Documentation

QList< QVariant > PageAPI::items

read

Scripter.activeDocument.activePage.items Property List of Item objects of active page

Checking whether it is a textframe. If yes, we are trying to cast it onto TextWrapper class, which can effectively perform all the text operations

int PageAPI::number

read

Scripter.activeDocument.activePage.position Property int value of active page number >= 1

int PageAPI::position

read

Scripter.activeDocument.activePage.position Property location of active page as int value (read-only)

QList< QVariant > PageAPI::selection

read

Scripter.activeDocument.activePage.selection Property List of selected Item objects on active page of active document

int PageAPI::type

read

Scripter.activeDocument.activePage.type Returns 0 if LeftPage, 1 if Middle Page, 2 for Right Page

The documentation for this class was generated from the following files:

/Users/ale/src/Scribus/scribus/plugins/scripter/api_page.h
/Users/ale/src/Scribus/scribus/plugins/scripter/api_page.cpp

Public Slots

Public Member Functions

Properties

Member Function Documentation

Property Documentation