RLayout

Class in Core Module
Header: #include <src/core/RLayout.h>
Inherits: RObject

Description

Represents a layout definition in a drawing.

Scriptable: This class is available in script environments.

Shared Pointer Support: Objects can be used in QSharedPointer.

Public Types


enum	PlotPaperUnits { `Inches, Millimeters, Pixels` }
enum	PlotRotation { `Zero, CounterClockWise, Inverted, ClockWise` }
enum	PlotType { `Display, Extents, Limits, View, Window, Layout` }
enum	StandardScaleType { Scale_ScaleToFit, Scale_1_128in_1ft, Scale_1_64in_1ft, Scale_1_32in_1ft, Scale_1_16in_1ft, Scale_3_32in_1ft, Scale_1_8in_1ft, Scale_3_16in_1ft, Scale_1_4in_1ft, Scale_3_8in_1ft, Scale_1_2in_1ft, Scale_3_4in_1ft, Scale_1in_1ft, Scale_3in_1ft, Scale_6in_1ft, Scale_1ft_1ft, Scale_1_1, Scale_1_2, Scale_1_4, Scale_1_5, Scale_1_8, Scale_1_10, Scale_1_16, Scale_1_20, Scale_1_30, Scale_1_40, Scale_1_50, Scale_1_100, Scale_2_1, Scale_4_1, Scale_8_1, Scale_10_1, Scale_100_1, Scale_1000_1, Scale_1and1_2in_1ft }

Public Functions


	RLayout`()`
	RLayout`(RDocument *document, const QString &name)`
virtual	~RLayout`()`
virtual QSharedPointer< RObject >	clone`() const`
QSharedPointer< RLayout >	cloneToLayout`() const`
QString	getCanonicalMediaName`() const`
double	getDenominatorCustomScale`() const`
RVector	getInsertionBase`() const`
RVector	getMaxExtents`() const`
RVector	getMaxLimits`() const`
RVector	getMinExtents`() const`
RVector	getMinLimits`() const`
QString	getName`() const`
double	getNumeratorCustomScale`() const`
RVector	getPlotOrigin`() const`
double	getPlotPaperMarginBottomMM`() const`
double	getPlotPaperMarginLeftMM`() const`
double	getPlotPaperMarginRightMM`() const`
double	getPlotPaperMarginTopMM`() const`
RVector	getPlotPaperSize`() const`
RLayout::PlotPaperUnits	getPlotPaperUnits`() const`
RLayout::PlotRotation	getPlotRotation`() const`
RLayout::PlotType	getPlotType`() const`
RVector	getPlotWindowAreaMax`() const`
RVector	getPlotWindowAreaMin`() const`
virtual QPair< QVariant, RPropertyAttributes >	getProperty`(RPropertyTypeId &propertyTypeId, bool humanReadable=false, bool noAttributes=false, bool showOnRequest=false)`
double	getStandardScale`() const`
RLayout::StandardScaleType	getStandardScaleType`() const`
int	getTabOrder`() const`
virtual RS::EntityType	getType`() const`
bool	getUseStandardScale`() const`
void	setCanonicalMediaName`(const QString &v)`
void	setDenominatorCustomScale`(double v)`
void	setInsertionBase`(const RVector &insertionBase)`
void	setMaxExtents`(const RVector &maxExtents)`
void	setMaxLimits`(const RVector &maxLimits)`
void	setMinExtents`(const RVector &minExtents)`
void	setMinLimits`(const RVector &minLimits)`
void	setName`(const QString &n)`
void	setNumeratorCustomScale`(double v)`
void	setPlotOrigin`(const RVector &v)`
void	setPlotPaperMarginBottomMM`(double v)`
void	setPlotPaperMarginLeftMM`(double v)`
void	setPlotPaperMarginRightMM`(double v)`
void	setPlotPaperMarginTopMM`(double v)`
void	setPlotPaperSize`(const RVector &v)`
void	setPlotPaperUnits`(RLayout::PlotPaperUnits v)`
void	setPlotRotation`(RLayout::PlotRotation v)`
void	setPlotType`(RLayout::PlotType v)`
void	setPlotWindowAreaMax`(const RVector &v)`
void	setPlotWindowAreaMin`(const RVector &v)`
virtual bool	setProperty`(RPropertyTypeId propertyTypeId, const QVariant &value, RTransaction *transaction=NULL)` Sets the given property to the given value.
void	setStandardScale`(double v)`
void	setStandardScaleType`(RLayout::StandardScaleType v)`
void	setTabOrder`(int to)`
void	setUseStandardScale`(bool v)`

Static Public Functions


static RS::EntityType	getRtti`()`
static void	init`()`

Static Public Attributes


static RPropertyTypeId	PropertyCanonicalMediaName
static RPropertyTypeId	PropertyCustom
static RPropertyTypeId	PropertyDenominatorCustomScale
static RPropertyTypeId	PropertyInsertionBaseX
static RPropertyTypeId	PropertyInsertionBaseY
static RPropertyTypeId	PropertyInsertionBaseZ
static RPropertyTypeId	PropertyMaxExtentsX
static RPropertyTypeId	PropertyMaxExtentsY
static RPropertyTypeId	PropertyMaxExtentsZ
static RPropertyTypeId	PropertyMaxLimitsX
static RPropertyTypeId	PropertyMaxLimitsY
static RPropertyTypeId	PropertyMaxLimitsZ
static RPropertyTypeId	PropertyMinExtentsX
static RPropertyTypeId	PropertyMinExtentsY
static RPropertyTypeId	PropertyMinExtentsZ
static RPropertyTypeId	PropertyMinLimitsX
static RPropertyTypeId	PropertyMinLimitsY
static RPropertyTypeId	PropertyMinLimitsZ
static RPropertyTypeId	PropertyName
static RPropertyTypeId	PropertyNumeratorCustomScale
static RPropertyTypeId	PropertyPlotOriginX
static RPropertyTypeId	PropertyPlotOriginY
static RPropertyTypeId	PropertyPlotPaperMarginBottomMM
static RPropertyTypeId	PropertyPlotPaperMarginLeftMM
static RPropertyTypeId	PropertyPlotPaperMarginRightMM
static RPropertyTypeId	PropertyPlotPaperMarginTopMM
static RPropertyTypeId	PropertyPlotPaperSizeHeight
static RPropertyTypeId	PropertyPlotPaperSizeWidth
static RPropertyTypeId	PropertyPlotPaperUnits
static RPropertyTypeId	PropertyPlotRotation
static RPropertyTypeId	PropertyPlotType
static RPropertyTypeId	PropertyPlotWindowAreaMaxX
static RPropertyTypeId	PropertyPlotWindowAreaMaxY
static RPropertyTypeId	PropertyPlotWindowAreaMinX
static RPropertyTypeId	PropertyPlotWindowAreaMinY
static RPropertyTypeId	PropertyStandardScale
static RPropertyTypeId	PropertyStandardScaleType
static RPropertyTypeId	PropertyTabOrder
static RPropertyTypeId	PropertyType
static RPropertyTypeId	PropertyUseStandardScale

Protected Functions


virtual void	print`(QDebug dbg) const`

Private Attributes


QString	canonicalMediaName
double	denominatorCustomScale
RVector	insertionBase
RVector	maxExtents
RVector	maxLimits
RVector	minExtents
RVector	minLimits
QString	name
double	numeratorCustomScale
RVector	plotOrigin
double	plotPaperMarginBottomMM
double	plotPaperMarginLeftMM
double	plotPaperMarginRightMM
double	plotPaperMarginTopMM
RVector	plotPaperSize
PlotPaperUnits	plotPaperUnits
PlotRotation	plotRotation
PlotType	plotType
RVector	plotWindowAreaMax
RVector	plotWindowAreaMin
double	standardScale
StandardScaleType	standardScaleType
int	tabOrder
bool	useStandardScale

Member Documentation

PlotPaperUnits

enum PlotPaperUnits

Value	Description
`Inches` `= 0`
`Millimeters` `= 1`
`Pixels` `= 2`

PlotRotation

enum PlotRotation

Value	Description
`Zero` `= 0`
`CounterClockWise` `= 1`
`Inverted` `= 2`
`ClockWise` `= 3`

PlotType

enum PlotType

Value	Description
`Display` `= 0`
`Extents` `= 1`
`Limits` `= 2`
`View` `= 3`
`Window` `= 4`
`Layout` `= 5`

StandardScaleType

enum StandardScaleType

Value	Description
`Scale_ScaleToFit` `= 0`
`Scale_1_128in_1ft` `= 1`
`Scale_1_64in_1ft` `= 2`
`Scale_1_32in_1ft` `= 3`
`Scale_1_16in_1ft` `= 4`
`Scale_3_32in_1ft` `= 5`
`Scale_1_8in_1ft` `= 6`
`Scale_3_16in_1ft` `= 7`
`Scale_1_4in_1ft` `= 8`
`Scale_3_8in_1ft` `= 9`
`Scale_1_2in_1ft` `= 10`
`Scale_3_4in_1ft` `= 11`
`Scale_1in_1ft` `= 12`
`Scale_3in_1ft` `= 13`
`Scale_6in_1ft` `= 14`
`Scale_1ft_1ft` `= 15`
`Scale_1_1` `= 16`
`Scale_1_2` `= 17`
`Scale_1_4` `= 18`
`Scale_1_5` `= 19`
`Scale_1_8` `= 20`
`Scale_1_10` `= 21`
`Scale_1_16` `= 22`
`Scale_1_20` `= 23`
`Scale_1_30` `= 24`
`Scale_1_40` `= 25`
`Scale_1_50` `= 26`
`Scale_1_100` `= 27`
`Scale_2_1` `= 28`
`Scale_4_1` `= 29`
`Scale_8_1` `= 30`
`Scale_10_1` `= 31`
`Scale_100_1` `= 32`
`Scale_1000_1` `= 33`
`Scale_1and1_2in_1ft` `= 34`

RLayout

RLayout::RLayout()

RLayout

RLayout::RLayout(RDocument *document, const QString &name)

~RLayout

virtual RLayout::~RLayout()

virtual

clone

virtual QSharedPointer< RObject > RLayout::clone() const

virtual inline const

Reimplemented from clone.

cloneToLayout

QSharedPointer< RLayout > RLayout::cloneToLayout() const

inline const

getCanonicalMediaName

QString RLayout::getCanonicalMediaName() const

inline const

getDenominatorCustomScale

double RLayout::getDenominatorCustomScale() const

inline const

getInsertionBase

RVector RLayout::getInsertionBase() const

inline const

getMaxExtents

RVector RLayout::getMaxExtents() const

inline const

getMaxLimits

RVector RLayout::getMaxLimits() const

inline const

getMinExtents

RVector RLayout::getMinExtents() const

inline const

getMinLimits

RVector RLayout::getMinLimits() const

inline const

getName

QString RLayout::getName() const

inline const

getNumeratorCustomScale

double RLayout::getNumeratorCustomScale() const

inline const

getPlotOrigin

RVector RLayout::getPlotOrigin() const

inline const

getPlotPaperMarginBottomMM

double RLayout::getPlotPaperMarginBottomMM() const

inline const

getPlotPaperMarginLeftMM

double RLayout::getPlotPaperMarginLeftMM() const

inline const

getPlotPaperMarginRightMM

double RLayout::getPlotPaperMarginRightMM() const

inline const

getPlotPaperMarginTopMM

double RLayout::getPlotPaperMarginTopMM() const

inline const

getPlotPaperSize

RVector RLayout::getPlotPaperSize() const

inline const

getPlotPaperUnits

RLayout::PlotPaperUnits RLayout::getPlotPaperUnits() const

inline const

getPlotRotation

RLayout::PlotRotation RLayout::getPlotRotation() const

inline const

getPlotType

RLayout::PlotType RLayout::getPlotType() const

inline const

getPlotWindowAreaMax

RVector RLayout::getPlotWindowAreaMax() const

inline const

getPlotWindowAreaMin

RVector RLayout::getPlotWindowAreaMin() const

inline const

getProperty

virtual QPair< QVariant, RPropertyAttributes > RLayout::getProperty(RPropertyTypeId &propertyTypeId, bool humanReadable=false, bool noAttributes=false, bool showOnRequest=false)

virtual

Returns: The value and attributes of the given property or an invalid property if this property owner has no property with the given ID.

Reimplemented from getProperty.

getStandardScale

double RLayout::getStandardScale() const

inline const

getStandardScaleType

RLayout::StandardScaleType RLayout::getStandardScaleType() const

inline const

getTabOrder

int RLayout::getTabOrder() const

inline const

getType

virtual RS::EntityType RLayout::getType() const

virtual inline const

Returns: The unique entity type, usually the same as RTTI, different for custom entities.

Reimplemented from getType.

getUseStandardScale

bool RLayout::getUseStandardScale() const

inline const

setCanonicalMediaName

void RLayout::setCanonicalMediaName(const QString &v)

inline

setDenominatorCustomScale

void RLayout::setDenominatorCustomScale(double v)

inline

setInsertionBase

void RLayout::setInsertionBase(const RVector &insertionBase)

inline

setMaxExtents

void RLayout::setMaxExtents(const RVector &maxExtents)

inline

setMaxLimits

void RLayout::setMaxLimits(const RVector &maxLimits)

inline

setMinExtents

void RLayout::setMinExtents(const RVector &minExtents)

inline

setMinLimits

void RLayout::setMinLimits(const RVector &minLimits)

inline

setName

void RLayout::setName(const QString &n)

setNumeratorCustomScale

void RLayout::setNumeratorCustomScale(double v)

inline

setPlotOrigin

void RLayout::setPlotOrigin(const RVector &v)

inline

setPlotPaperMarginBottomMM

void RLayout::setPlotPaperMarginBottomMM(double v)

inline

setPlotPaperMarginLeftMM

void RLayout::setPlotPaperMarginLeftMM(double v)

inline

setPlotPaperMarginRightMM

void RLayout::setPlotPaperMarginRightMM(double v)

inline

setPlotPaperMarginTopMM

void RLayout::setPlotPaperMarginTopMM(double v)

inline

setPlotPaperSize

void RLayout::setPlotPaperSize(const RVector &v)

inline

setPlotPaperUnits

void RLayout::setPlotPaperUnits(RLayout::PlotPaperUnits v)

inline

setPlotRotation

void RLayout::setPlotRotation(RLayout::PlotRotation v)

inline

setPlotType

void RLayout::setPlotType(RLayout::PlotType v)

inline

setPlotWindowAreaMax

void RLayout::setPlotWindowAreaMax(const RVector &v)

inline

setPlotWindowAreaMin

void RLayout::setPlotWindowAreaMin(const RVector &v)

inline

setProperty

virtual bool RLayout::setProperty(RPropertyTypeId propertyTypeId, const QVariant &value, RTransaction *transaction=NULL)

virtual

Sets the given property to the given value.

If this property owner does not know a property with that ID, it is up to the property owner what happens. The property might be added into a list of dynamic properties or dropped.

Returns: True if the property owner was modified in any way, false otherwise.

Reimplemented from setProperty.

setStandardScale

void RLayout::setStandardScale(double v)

inline

setStandardScaleType

void RLayout::setStandardScaleType(RLayout::StandardScaleType v)

inline

setTabOrder

void RLayout::setTabOrder(int to)

inline

setUseStandardScale

void RLayout::setUseStandardScale(bool v)

inline

getRtti

static RS::EntityType RLayout::getRtti()

static inline

init

static void RLayout::init()

static

PropertyCanonicalMediaName

static RPropertyTypeId RLayout::PropertyCanonicalMediaName

static

PropertyCustom

static RPropertyTypeId RLayout::PropertyCustom

static

PropertyDenominatorCustomScale

static RPropertyTypeId RLayout::PropertyDenominatorCustomScale

static

PropertyInsertionBaseX

static RPropertyTypeId RLayout::PropertyInsertionBaseX

static

PropertyInsertionBaseY

static RPropertyTypeId RLayout::PropertyInsertionBaseY

static

PropertyInsertionBaseZ

static RPropertyTypeId RLayout::PropertyInsertionBaseZ

static

PropertyMaxExtentsX

static RPropertyTypeId RLayout::PropertyMaxExtentsX

static

PropertyMaxExtentsY

static RPropertyTypeId RLayout::PropertyMaxExtentsY

static

PropertyMaxExtentsZ

static RPropertyTypeId RLayout::PropertyMaxExtentsZ

static

PropertyMaxLimitsX

static RPropertyTypeId RLayout::PropertyMaxLimitsX

static

PropertyMaxLimitsY

static RPropertyTypeId RLayout::PropertyMaxLimitsY

static

PropertyMaxLimitsZ

static RPropertyTypeId RLayout::PropertyMaxLimitsZ

static

PropertyMinExtentsX

static RPropertyTypeId RLayout::PropertyMinExtentsX

static

PropertyMinExtentsY

static RPropertyTypeId RLayout::PropertyMinExtentsY

static

PropertyMinExtentsZ

static RPropertyTypeId RLayout::PropertyMinExtentsZ

static

PropertyMinLimitsX

static RPropertyTypeId RLayout::PropertyMinLimitsX

static

PropertyMinLimitsY

static RPropertyTypeId RLayout::PropertyMinLimitsY

static

PropertyMinLimitsZ

static RPropertyTypeId RLayout::PropertyMinLimitsZ

static

PropertyName

static RPropertyTypeId RLayout::PropertyName

static

PropertyNumeratorCustomScale

static RPropertyTypeId RLayout::PropertyNumeratorCustomScale

static

PropertyPlotOriginX

static RPropertyTypeId RLayout::PropertyPlotOriginX

static

PropertyPlotOriginY

static RPropertyTypeId RLayout::PropertyPlotOriginY

static

PropertyPlotPaperMarginBottomMM

static RPropertyTypeId RLayout::PropertyPlotPaperMarginBottomMM

static

PropertyPlotPaperMarginLeftMM

static RPropertyTypeId RLayout::PropertyPlotPaperMarginLeftMM

static

PropertyPlotPaperMarginRightMM

static RPropertyTypeId RLayout::PropertyPlotPaperMarginRightMM

static

PropertyPlotPaperMarginTopMM

static RPropertyTypeId RLayout::PropertyPlotPaperMarginTopMM

static

PropertyPlotPaperSizeHeight

static RPropertyTypeId RLayout::PropertyPlotPaperSizeHeight

static

PropertyPlotPaperSizeWidth

static RPropertyTypeId RLayout::PropertyPlotPaperSizeWidth

static

PropertyPlotPaperUnits

static RPropertyTypeId RLayout::PropertyPlotPaperUnits

static

PropertyPlotRotation

static RPropertyTypeId RLayout::PropertyPlotRotation

static

PropertyPlotType

static RPropertyTypeId RLayout::PropertyPlotType

static

PropertyPlotWindowAreaMaxX

static RPropertyTypeId RLayout::PropertyPlotWindowAreaMaxX

static

PropertyPlotWindowAreaMaxY

static RPropertyTypeId RLayout::PropertyPlotWindowAreaMaxY

static

PropertyPlotWindowAreaMinX

static RPropertyTypeId RLayout::PropertyPlotWindowAreaMinX

static

PropertyPlotWindowAreaMinY

static RPropertyTypeId RLayout::PropertyPlotWindowAreaMinY

static

PropertyStandardScale

static RPropertyTypeId RLayout::PropertyStandardScale

static

PropertyStandardScaleType

static RPropertyTypeId RLayout::PropertyStandardScaleType

static

PropertyTabOrder

static RPropertyTypeId RLayout::PropertyTabOrder

static

PropertyType

static RPropertyTypeId RLayout::PropertyType

static

This file is part of the QCAD project.

QCAD is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

QCAD 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with QCAD.

PropertyUseStandardScale

static RPropertyTypeId RLayout::PropertyUseStandardScale

static

print

virtual void RLayout::print(QDebug dbg) const

virtual const protected

Non-Scriptable: This function is not available in script environments.

Reimplemented from print.

canonicalMediaName

QString RLayout::canonicalMediaName

private

denominatorCustomScale

double RLayout::denominatorCustomScale

private

insertionBase

RVector RLayout::insertionBase

private

maxExtents

RVector RLayout::maxExtents

private

maxLimits

RVector RLayout::maxLimits

private

minExtents

RVector RLayout::minExtents

private

minLimits

RVector RLayout::minLimits

private

name

QString RLayout::name

private

numeratorCustomScale

double RLayout::numeratorCustomScale

private

plotOrigin

RVector RLayout::plotOrigin

private

plotPaperMarginBottomMM

double RLayout::plotPaperMarginBottomMM

private

plotPaperMarginLeftMM

double RLayout::plotPaperMarginLeftMM

private

plotPaperMarginRightMM

double RLayout::plotPaperMarginRightMM

private

plotPaperMarginTopMM

double RLayout::plotPaperMarginTopMM

private

plotPaperSize

RVector RLayout::plotPaperSize

private

plotPaperUnits

PlotPaperUnits RLayout::plotPaperUnits

private

plotRotation

PlotRotation RLayout::plotRotation

private

plotType

PlotType RLayout::plotType

private

plotWindowAreaMax

RVector RLayout::plotWindowAreaMax

private

plotWindowAreaMin

RVector RLayout::plotWindowAreaMin

private

standardScale

double RLayout::standardScale

private

standardScaleType

StandardScaleType RLayout::standardScaleType

private

tabOrder

int RLayout::tabOrder

private

useStandardScale

bool RLayout::useStandardScale

private