QCAD
Open Source 2D CAD
RLayout Class Reference

Represents a layout definition in a drawing. More...

#include <RLayout.h>

Inheritance diagram for RLayout:
RObject

Public Types

enum  PlotPaperUnits { Inches = 0, Millimeters = 1, Pixels = 2 }
 
enum  PlotRotation { Zero = 0, CounterClockWise = 1, Inverted = 2, ClockWise = 3 }
 
- Public Types inherited from RObject
typedef int Handle
 
typedef int Id
 
enum  XYZ { X, Y, Z }
 

Public Member Functions

virtual RLayoutclone () const
 
RVector getInsertionBase () const
 
RVector getMaxExtents () const
 
RVector getMaxLimits () const
 
RVector getMinExtents () const
 
RVector getMinLimits () const
 
QString getName () const
 
virtual QPair< QVariant, RPropertyAttributesgetProperty (RPropertyTypeId &propertyTypeId, bool humanReadable=false, bool noAttributes=false)
 
int getTabOrder () const
 
virtual RS::EntityType getType () const
 
virtual bool isSelectedForPropertyEditing ()
 
 RLayout ()
 
 RLayout (RDocument *document, const QString &name)
 
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)
 
virtual bool setProperty (RPropertyTypeId propertyTypeId, const QVariant &value, RTransaction *transaction=NULL)
 Sets the given property to the given value. More...
 
void setTabOrder (int to)
 
virtual ~RLayout ()
 
- Public Member Functions inherited from RObject
void copyCustomPropertiesFrom (RObject *other, const QString &title=RDEFAULT_QSTRING)
 Copies all custom properties from the given object. More...
 
void dump () const
 
virtual int getComplexity () const
 
bool getCustomBoolProperty (const QString &title, const QString &key, bool defaultValue) const
 
double getCustomDoubleProperty (const QString &title, const QString &key, double defaultValue) const
 
int getCustomIntProperty (const QString &title, const QString &key, int defaultValue) const
 
QMap< QString, QVariantMap > getCustomProperties () const
 
QVariant getCustomProperty (const QString &title, const QString &key, const QVariant &defaultValue=RDEFAULT_QVARIANT) const
 
QStringList getCustomPropertyKeys (const QString &title) const
 
QStringList getCustomPropertyTitles () const
 
virtual QSet< RPropertyTypeIdgetCustomPropertyTypeIds () const
 
RDocumentgetDocument ()
 
const RDocumentgetDocument () const
 
RObject::Handle getHandle () const
 
RObject::Id getId () const
 
virtual QSet< RPropertyTypeIdgetPropertyTypeIds () const
 
bool hasCustomProperties () const
 
bool hasCustomProperty (const QString &title, const QString &key) const
 
bool hasCustomProperty (const QString &title, const QRegExp &key) const
 
virtual bool hasPropertyType (RPropertyTypeId propertyTypeId)
 
bool isProtected () const
 
bool isUndone () const
 
void removeCustomProperty (const QString &title, const QString &key)
 Removes the custom property with the given name. More...
 
 RObject (RDocument *document=NULL)
 
 RObject (const RObject &other)
 
virtual void setAutoUpdatesBlocked (bool on)
 
void setCustomProperty (const QString &title, const QString &key, const QVariant &value)
 Sets a custom property with the given name. More...
 
void setDocument (RDocument *document)
 
void setProtected (bool on)
 
virtual ~RObject ()
 

Static Public Member Functions

static void init ()
 
- Static Public Member Functions inherited from RObject
static void init ()
 
template<class T >
static bool setMember (T &variable, const QVariant &value, bool condition=true)
 

Static Public Attributes

static RPropertyTypeId PropertyCustom
 Copyright (c) 2011-2017 by Andrew Mustun. More...
 
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 PropertyTabOrder
 
- Static Public Attributes inherited from RObject
static const Handle INVALID_HANDLE = -1
 
static const Id INVALID_ID = -1
 Copyright (c) 2011-2017 by Andrew Mustun. More...
 
static RPropertyTypeId PropertyCustom
 
static RPropertyTypeId PropertyHandle
 
static RPropertyTypeId PropertyProtected
 
static RPropertyTypeId PropertyType
 

Protected Member Functions

virtual void print (QDebug dbg) const
 
- Protected Member Functions inherited from RObject
void setHandle (RObject::Handle h)
 
void setId (RObject::Id id)
 
void setUndone (bool on)
 

Private Attributes

RVector insertionBase
 
RVector maxExtents
 
RVector maxLimits
 
RVector minExtents
 
RVector minLimits
 
QString name
 
int tabOrder
 

Additional Inherited Members

- Static Protected Member Functions inherited from RObject
static bool setMember (QString &variable, const QVariant &value, bool condition=true)
 Sets the given property. More...
 
static bool setMember (double &variable, const QVariant &value, bool condition=true)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
static bool setMember (int &variable, const QVariant &value, bool condition=true)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
static bool setMember (bool &variable, const QVariant &value, bool condition=true)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
static bool setMember (QList< double > &variable, const QVariant &value, bool condition)
 
static bool setMemberVector (QList< RVector > &variable, const QVariant &value, RObject::XYZ xyz)
 
static bool setMemberX (QList< RVector > &variable, const QVariant &value, bool condition=true)
 
static bool setMemberY (QList< RVector > &variable, const QVariant &value, bool condition=true)
 
static bool setMemberZ (QList< RVector > &variable, const QVariant &value, bool condition=true)
 

Detailed 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.

Constructor & Destructor Documentation

RLayout::RLayout ( )
RLayout::RLayout ( RDocument document,
const QString &  name 
)
RLayout::~RLayout ( )
virtual

Member Function Documentation

RLayout * RLayout::clone ( ) const
virtual

Implements RObject.

RVector RLayout::getInsertionBase ( ) const
inline
RVector RLayout::getMaxExtents ( ) const
inline
RVector RLayout::getMaxLimits ( ) const
inline
RVector RLayout::getMinExtents ( ) const
inline
RVector RLayout::getMinLimits ( ) const
inline
QString RLayout::getName ( ) const
inline
QPair< QVariant, RPropertyAttributes > RLayout::getProperty ( RPropertyTypeId propertyTypeId,
bool  humanReadable = false,
bool  noAttributes = 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 RObject.

int RLayout::getTabOrder ( ) const
inline
virtual RS::EntityType RLayout::getType ( ) const
inlinevirtual

Implements RObject.

void RLayout::init ( )
static
bool RLayout::isSelectedForPropertyEditing ( )
virtual
Returns
True if this object is selected for editing. This means that the properties of this object should for example be shown in a property editor.

Implements RObject.

void RLayout::print ( QDebug  dbg) const
protectedvirtual
Non-Scriptable:
This function is not available in script environments.

Reimplemented from RObject.

void RLayout::setInsertionBase ( const RVector insertionBase)
inline
void RLayout::setMaxExtents ( const RVector maxExtents)
inline
void RLayout::setMaxLimits ( const RVector maxLimits)
inline
void RLayout::setMinExtents ( const RVector minExtents)
inline
void RLayout::setMinLimits ( const RVector minLimits)
inline
void RLayout::setName ( const QString &  n)
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 RObject.

void RLayout::setTabOrder ( int  to)
inline

Member Data Documentation

RVector RLayout::insertionBase
private
RVector RLayout::maxExtents
private
RVector RLayout::maxLimits
private
RVector RLayout::minExtents
private
RVector RLayout::minLimits
private
QString RLayout::name
private
RPropertyTypeId RLayout::PropertyCustom
static

Copyright (c) 2011-2017 by Andrew Mustun.

All rights reserved.

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.

RPropertyTypeId RLayout::PropertyInsertionBaseX
static
RPropertyTypeId RLayout::PropertyInsertionBaseY
static
RPropertyTypeId RLayout::PropertyInsertionBaseZ
static
RPropertyTypeId RLayout::PropertyMaxExtentsX
static
RPropertyTypeId RLayout::PropertyMaxExtentsY
static
RPropertyTypeId RLayout::PropertyMaxExtentsZ
static
RPropertyTypeId RLayout::PropertyMaxLimitsX
static
RPropertyTypeId RLayout::PropertyMaxLimitsY
static
RPropertyTypeId RLayout::PropertyMaxLimitsZ
static
RPropertyTypeId RLayout::PropertyMinExtentsX
static
RPropertyTypeId RLayout::PropertyMinExtentsY
static
RPropertyTypeId RLayout::PropertyMinExtentsZ
static
RPropertyTypeId RLayout::PropertyMinLimitsX
static
RPropertyTypeId RLayout::PropertyMinLimitsY
static
RPropertyTypeId RLayout::PropertyMinLimitsZ
static
RPropertyTypeId RLayout::PropertyName
static
RPropertyTypeId RLayout::PropertyTabOrder
static
int RLayout::tabOrder
private

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