#include <PropertySheet.h>

Public Member Functions
virtual bool adjustLink (const std::set< App::DocumentObject * > &inList) override
	Called to adjust the link to avoid potential cyclic dependency. More...

virtual void afterRestore () override
	Called at the beginning of Document::afterRestore() More...

virtual void breakLink (App::DocumentObject *obj, bool clear) override
	Called to reset this link property. More...

void clear ()

void clear (App::CellAddress address)

void clearDirty ()

void clearDirty (App::CellAddress key)

virtual Property * Copy (void) const override
	Returns a new copy of the property (mainly for Undo/Redo and transactions) More...

void copyCells (Base::Writer &writer, const std::vector< App::Range > &ranges) const

virtual Property * CopyOnImportExternal (const std::map< std::string, std::string > &nameMap) const override
	Return a copy of the property if any changes caused by importing external linked object. More...

virtual Property * CopyOnLabelChange (App::DocumentObject obj, const std::string &ref, const char newLabel) const override
	Update object label reference in this property. More...

virtual Property * CopyOnLinkReplace (const App::DocumentObject parent, App::DocumentObject oldObj, App::DocumentObject *newObj) const override
	Return a copy of the property if the link replacement affects this property. More...

Cell * createCell (App::CellAddress address)

void deletedDocumentObject (const App::DocumentObject *docObj)

void documentSet ()

std::string getColumn (int offset=0) const

const std::set< std::string > & getDeps (App::CellAddress pos) const

const std::set< App::CellAddress > & getDeps (const std::string &name) const

const std::set< App::CellAddress > & getDirty ()

virtual std::map< App::ObjectIdentifier, const App::Expression * > getExpressions () const override

virtual unsigned int getMemSize (void) const override
	This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? This method is defined in Base::Persistence. More...

PyObject * getPyObject (void) override
	This method returns the Python wrapper for a C++ object. More...

std::string getRow (int offset=0) const

void getSpans (App::CellAddress address, int &rows, int &cols) const

std::set< App::CellAddress > getUsedCells () const

Cell * getValue (App::CellAddress key)

const Cell * getValue (App::CellAddress key) const

const Cell * getValueFromAlias (const std::string &alias) const

void insertColumns (int col, int count)

void insertRows (int row, int count)

void invalidateDependants (const App::DocumentObject *docObj)

bool isDirty () const

bool isHidden (App::CellAddress address) const

bool isMergedCell (App::CellAddress address) const

bool isValidAlias (const std::string &candidate)

bool mergeCells (App::CellAddress from, App::CellAddress to)

void moveCell (App::CellAddress currPos, App::CellAddress newPos, std::map< App::ObjectIdentifier, App::ObjectIdentifier > &renames)

virtual void onContainerRestored () override
	Called before calling DocumentObject::onDocumentRestored() More...

virtual void onRelabeledDocument (const App::Document &doc) override

virtual void Paste (const Property &from) override

void pasteCells (Base::XMLReader &reader, const App::CellAddress &addr)

void pasteCells (const std::map< App::CellAddress, std::string > &cells, int rowOffset, int colOffset)

PropertySheet (Sheet *_owner=0)

void recomputeDependencies (App::CellAddress key)

virtual bool referenceChanged () const override
	Test if the element reference has changed after restore. More...

void removeColumns (int col, int count)

void removeRows (int row, int count)

void renamedDocumentObject (const App::DocumentObject *docObj)

void renameObjectIdentifiers (const std::map< App::ObjectIdentifier, App::ObjectIdentifier > &paths)

virtual void Restore (Base::XMLReader &reader) override
	This method is used to restore properties from an XML document. More...

virtual void Save (Base::Writer &writer) const override
	This method is used to save properties to an XML document. More...

void setAlias (App::CellAddress address, const std::string &alias)

void setAlignment (App::CellAddress address, int _alignment)

void setBackground (App::CellAddress address, const App::Color &color)

void setComputedUnit (App::CellAddress address, const Base::Unit &unit)

void setContent (App::CellAddress address, const char *value)

void setDirty ()

void setDirty (App::CellAddress address)

void setDisplayUnit (App::CellAddress address, const std::string &unit)

virtual void setExpressions (std::map< App::ObjectIdentifier, App::ExpressionPtr > &&exprs) override

void setForeground (App::CellAddress address, const App::Color &color)

void setPyObject (PyObject *) override

void setSpans (App::CellAddress address, int rows, int columns)

void setStyle (App::CellAddress address, const std::set< std::string > &_style)

void setValue ()

Sheet * sheet () const

void splitCell (App::CellAddress address)

virtual void updateElementReference (App::DocumentObject *feature, bool reverse=false, bool notify=false) override
	Link type property interface APIs These APIs are moved here so that any type of property can have the property link behavior, e.g. More...

~PropertySheet ()

Public Member Functions inherited from App::PropertyExpressionContainer
PropertyExpressionContainer ()

virtual ~PropertyExpressionContainer ()

Public Member Functions inherited from App::PropertyXLinkContainer
virtual int checkRestore (std::string *msg=0) const override
	Test if the link is restored unchanged. More...

virtual void getLinks (std::vector< App::DocumentObject * > &objs, bool all=false, std::vector< std::string > *subs=0, bool newStyle=true) const override
	Obtain the linked objects. More...

bool isLinkedToDocument (const App::Document &doc) const

PropertyXLinkContainer ()

~PropertyXLinkContainer ()

Public Member Functions inherited from App::PropertyLinkBase
void checkLabelReferences (const std::vector< std::string > &subs, bool reset=true)
	Check subnames for label registration. More...

void getLinkedElements (std::map< App::DocumentObject *, std::vector< std::string > > &elements, bool newStyle=true, bool all=true) const
	Helper function to return a map of linked object and its subname references. More...

template<class T >
void getLinkedObjects (T &inserter, bool all=false) const
	Helper function to return linked objects using an std::inserter. More...

std::map< App::DocumentObject *, std::vector< std::string > > linkedElements (bool newStyle=true, bool all=true) const
	Helper function to return a map of linked object and its subname references. More...

std::vector< App::DocumentObject * > linkedObjects (bool all=false) const
	Helper function to return all linked objects of this property. More...

PropertyLinkBase ()

void registerLabelReferences (std::vector< std::string > &&labels, bool reset=true)
	Register label reference for future object relabel update. More...

void setAllowExternal (bool allow)
	Enable/disable temporary holding external object without throwing exception. More...

virtual void setAllowPartial (bool enable)

bool testFlag (int flag) const

void unregisterElementReference ()
	Clear internal element reference registration. More...

void unregisterLabelReferences ()
	Clear internal label references registration. More...

virtual ~PropertyLinkBase ()

Public Member Functions inherited from App::Property
virtual App::ObjectIdentifier canonicalPath (const App::ObjectIdentifier &p) const
	Convert p to a canonical representation of it. More...

PropertyContainer * getContainer (void) const
	Get a pointer to the PropertyContainer derived class the property belongs to. More...

const char * getDocumentation (void) const
	Get the documentation of this property. More...

virtual const char * getEditorName (void) const
	Get the class name of the associated property editor item. More...

std::string getFullName () const

const char * getGroup (void) const
	Get the group of this property. More...

const char * getName (void) const
	get the name of this property in the belonging container More...

virtual void getPaths (std::vector< App::ObjectIdentifier > &paths) const
	Get valid paths for this property; used by auto completer. More...

virtual const boost::any getPathValue (const App::ObjectIdentifier &path) const
	Get value of property. More...

virtual bool getPyPathValue (const App::ObjectIdentifier &, Py::Object &) const
	Get Python value of property. More...

unsigned long getStatus () const
	return the status bits More...

short getType (void) const
	Get the type of the property in the container. More...

bool isReadOnly () const

bool isSinglePrecision () const
	Gets precision of properties using floating point numbers. More...

bool isTouched (void) const
	Test if this property is touched. More...

virtual void Paste (const Property &from)=0
	Paste the value from the property (mainly for Undo/Redo and transactions) More...

Property ()

void purgeTouched (void)
	Reset this property touched. More...

void setContainer (PropertyContainer *Father)
	Is called by the framework to set the father (container) More...

virtual void setPathValue (const App::ObjectIdentifier &path, const boost::any &value)
	Set value of property. More...

void setReadOnly (bool readOnly)
	Sets property editable/grayed out in property editor. More...

void setSinglePrecision (bool single)
	Sets precision of properties using floating point numbers to single, the default is double. More...

void setStatus (Status pos, bool on)

void setStatusValue (unsigned long status)

bool testStatus (Status pos) const

void touch ()
	Property status handling. More...

virtual ~Property ()

Public Member Functions inherited from Base::Persistence
void dumpToStream (std::ostream &stream, int compression)

virtual Base::Type getTypeId (void) const

virtual void RestoreDocFile (Reader &)
	This method is used to restore large amounts of data from a file In this method you simply stream in your SaveDocFile() saved data. More...

void restoreFromStream (std::istream &stream)

virtual void SaveDocFile (Writer &) const
	This method is used to save large amounts of data to a binary file. More...

Public Member Functions inherited from Base::BaseClass
BaseClass ()
	Construction. More...

bool isDerivedFrom (const Type type) const

virtual ~BaseClass ()
	Destruction. More...

Public Member Functions inherited from App::ScopedLink
LinkScope getScope ()
	Get the links scope Retrieve what kind of links are allowed. More...

void setScope (LinkScope scope)
	Set the links scope Allows to define what kind of links are allowed. More...

Protected Member Functions
virtual void hasSetChildValue (App::Property &prop) override
	Called when a child property has changed value. More...

virtual void hasSetValue () override
	Gets called by all setValue() methods after the value has changed. More...

virtual void onAddDep (App::DocumentObject *obj) override

virtual void onBreakLink (App::DocumentObject *obj) override

virtual void onRemoveDep (App::DocumentObject *obj) override

Protected Member Functions inherited from App::PropertyXLinkContainer
virtual void aboutToSetChildValue (App::Property &prop) override
	Called before a child property changing value. More...

void clearDeps ()

virtual PropertyXLink * createXLink ()

void updateDeps (std::set< DocumentObject * > &&newDeps)

Protected Member Functions inherited from App::PropertyLinkBase
void setFlag (int flag, bool value=true)

Protected Member Functions inherited from App::Property
virtual void aboutToSetValue (void)
	Gets called by all setValue() methods before the value has changed. More...

virtual void verifyPath (const App::ObjectIdentifier &p) const
	Verify a path for the current property. More...

Friends
class AtomicPropertyChange

class Cell

class Sheet

class SheetObserver

Additional Inherited Members
Public Types inherited from App::PropertyLinkBase
enum LinkFlags { LinkAllowExternal, LinkDetached, LinkRestoring, LinkAllowPartial, LinkRestoreLabel }

typedef std::pair< std::string, std::string > ShadowSub

Public Types inherited from App::Property
enum Status { Touched = 0, Immutable = 1, ReadOnly = 2, Hidden = 3, Transient = 4, MaterialEdit = 5, NoMaterialListEdit = 6, Output = 7, LockDynamic = 8, NoModify = 9, PartialTrigger = 10, NoRecompute = 11, Single = 12, Ordered = 13, EvalOnRestore = 14, PropStaticBegin = 21, PropDynamic = 21, PropNoPersist = 22, PropNoRecompute = 23, PropReadOnly = 24, PropTransient = 25, PropHidden = 26, PropOutput = 27, PropStaticEnd = 28, User1 = 28, User2 = 29, User3 = 30, User4 = 31 }

Static Public Member Functions inherited from App::PropertyLinkBase
static void breakLinks (App::DocumentObject link, const std::vector< App::DocumentObject > &objs, bool clear)
	Helper function for breaking link properties. More...

static const char * exportSubName (std::string &output, const App::DocumentObject obj, const char subname, bool first_obj=false)
	Helper function to export a subname reference. More...

static void getLabelReferences (std::vector< std::string > &labels, const char *subname)
	Helper function to extract labels from a subname reference. More...

static std::string importSubName (Base::XMLReader &reader, const char *sub, bool &restoreLabel)
	Helper function to import a subname reference. More...

static void restoreLabelReference (const App::DocumentObject obj, std::string &sub, ShadowSub shadow=0)
	Helper function to restore label references during import. More...

static App::DocumentObject * tryImport (const App::Document doc, const App::DocumentObject obj, const std::map< std::string, std::string > &nameMap)
	Helper function for link import operation. More...

static std::string tryImportSubName (const App::DocumentObject obj, const char sub, const App::Document *doc, const std::map< std::string, std::string > &nameMap)
	Helper function for link import operation. More...

static std::pair< App::DocumentObject , std::string > tryReplaceLink (const App::PropertyContainer owner, App::DocumentObject obj, const App::DocumentObject parent, App::DocumentObject oldObj, App::DocumentObject newObj, const char *sub=0)
	Helper functions. More...

static std::pair< App::DocumentObject , std::vector< std::string > > tryReplaceLinkSubs (const App::PropertyContainer owner, App::DocumentObject obj, const App::DocumentObject parent, App::DocumentObject oldObj, App::DocumentObject newObj, const std::vector< std::string > &subs)
	Helper function to check and replace a link with multiple subname references. More...

static void updateElementReferences (DocumentObject *feature, bool reverse=false)
	Update all element references in all link properties of feature. More...

static std::string updateLabelReference (const App::DocumentObject linked, const char subname, App::DocumentObject obj, const std::string &ref, const char newLabel)
	Helper function to update subname reference on label change. More...

static std::vector< std::pair< Property , std::unique_ptr< Property > > > updateLabelReferences (App::DocumentObject obj, const char *newLabel)
	Helper function to collect changed property when an object re-label. More...

Static Public Member Functions inherited from App::Property
static void destroy (Property *p)
	For safe deleting of a dynamic property. More...

Static Public Member Functions inherited from Base::Persistence
static void * create (void)

static std::string encodeAttribute (const std::string &)
	Encodes an attribute upon saving. More...

static Base::Type getClassTypeId (void)

static void init (void)

Static Public Member Functions inherited from Base::BaseClass
static void * create (void)

static Type getClassTypeId (void)

static void init (void)

Static Protected Member Functions inherited from Base::BaseClass
static void initSubclass (Base::Type &toInit, const char ClassName, const char ParentName, Type::instantiationMethod method=nullptr)

Protected Attributes inherited from App::Property
std::bitset< 32 > StatusBits
	Status bits of the property The first 8 bits are used for the base system the rest can be used in descendent classes to mark special statuses on the objects. More...

Constructor & Destructor Documentation

◆ PropertySheet()

PropertySheet::PropertySheet ( Sheet * _owner = 0 )

Referenced by Copy(), CopyOnImportExternal(), CopyOnLabelChange(), and CopyOnLinkReplace().

◆ ~PropertySheet()

PropertySheet::~PropertySheet ( )

References clear().

Member Function Documentation

◆ adjustLink()

bool PropertySheet::adjustLink ( const std::set< App::DocumentObject * > & inList )

overridevirtual

Called to adjust the link to avoid potential cyclic dependency.

Parameters

inList recursive in-list of the would-be parent

Returns: Return whether the link has been adjusted

This function tries to correct the link to avoid any (sub)object inside in-list. If the adjustment is impossible, exception will be raised

Implements App::PropertyLinkBase.

References AtomicPropertyChange, and App::DocumentObject::getFullName().

◆ afterRestore()

void PropertySheet::afterRestore ( )

overridevirtual

Called at the beginning of Document::afterRestore()

This function is called without dependency sorting, because some types of link property can only reconstructs the linking information inside this function.

One example use case of this function is PropertyLinkSub that uses afterRestore() to parse and restore subname references, which may contain sub-object reference from external document, and there will be special mapping required during object import.

Another example is PropertyExpressionEngine which only parse the restored expression in afterRestore(). The reason, in addition to subname mapping like PropertyLinkSub, is that it can handle document name adjustment as well. It internally relies on PropertyXLink to store the external document path for external linking. When the external document is restored, its internal name may change due to name conflict with existing documents. PropertyExpressionEngine can now auto adjust external references without any problem.

Reimplemented from App::PropertyXLinkContainer.

References AtomicPropertyChange, setDirty(), and App::Property::touch().

◆ breakLink()

void PropertySheet::breakLink	(	App::DocumentObject *	obj,
		bool	clear
	)

overridevirtual

Called to reset this link property.

Parameters

obj	reset link property if it is linked to this object
clear	if true, then also reset property if the owner of this property is obj

See also: breakLinks()

Reimplemented from App::PropertyXLinkContainer.

References AtomicPropertyChange, and clear().

◆ clear() [1/2]

void PropertySheet::clear ( )

Referenced by breakLink(), mergeCells(), moveCell(), Paste(), removeColumns(), removeRows(), setExpressions(), and ~PropertySheet().

◆ clear() [2/2]

void PropertySheet::clear ( App::CellAddress address )

References AtomicPropertyChange, and splitCell().

Referenced by Spreadsheet::Sheet::clear(), and Spreadsheet::Sheet::clearAll().

◆ clearDirty() [1/2]

void Spreadsheet::PropertySheet::clearDirty ( )

◆ clearDirty() [2/2]

void Spreadsheet::PropertySheet::clearDirty ( App::CellAddress key )

Referenced by Spreadsheet::Cell::clearDirty(), and Spreadsheet::Sheet::recomputeCell().

◆ Copy()

App::Property * PropertySheet::Copy ( void ) const

overridevirtual

Returns a new copy of the property (mainly for Undo/Redo and transactions)

Implements App::Property.

References PropertySheet().

◆ copyCells()

void PropertySheet::copyCells	(	Base::Writer &	writer,
		const std::vector< App::Range > &	ranges
	)		const

References Base::Writer::decInd(), getValue(), Base::Writer::incInd(), Base::Writer::ind(), and Base::Writer::Stream().

Referenced by SpreadsheetGui::SheetTableView::copySelection().

◆ CopyOnImportExternal()

Property * PropertySheet::CopyOnImportExternal ( const std::map< std::string, std::string > & nameMap ) const

overridevirtual

Return a copy of the property if any changes caused by importing external linked object.

Parameters

nameMap a map from the original external object name to the imported new object name

Returns: Returns a copy of the property with the updated link reference if affected. The copy will later be assgiend to this property by calling its Paste().

Reimplemented from App::PropertyLinkBase.

References PropertySheet().

◆ CopyOnLabelChange()

Property * PropertySheet::CopyOnLabelChange	(	App::DocumentObject *	obj,
		const std::string &	ref,
		const char *	newLabel
	)		const

overridevirtual

Update object label reference in this property.

Parameters

obj	the object owner of the changing label
ref	subname reference to old label
newLabel	the future new label

Returns: Returns a copy of the property if its link reference is affected. The copy will later be assgiend to this property by calling its Paste().

Reimplemented from App::PropertyLinkBase.

References PropertySheet().

◆ CopyOnLinkReplace()

Property * PropertySheet::CopyOnLinkReplace	(	const App::DocumentObject *	parent,
		App::DocumentObject *	oldObj,
		App::DocumentObject *	newObj
	)		const

overridevirtual

Return a copy of the property if the link replacement affects this property.

Parameters

owner	the parent object whose link property is to be replace. Note that The parent may not be the container of this property. Link sub property can use this opportunity to adjust its relative links.
oldObj	object to be replaced
newObj	object to replace with

Returns: Return a copy of the property that is adjusted for the link replacement operation.

Implements App::PropertyLinkBase.

References PropertySheet().

◆ createCell()

Cell * PropertySheet::createCell ( App::CellAddress address )

References Cell.

Referenced by Spreadsheet::Sheet::getNewCell(), and Restore().

◆ deletedDocumentObject()

void PropertySheet::deletedDocumentObject ( const App::DocumentObject * docObj )

Referenced by Spreadsheet::SheetObserver::slotDeletedObject().

◆ documentSet()

void PropertySheet::documentSet ( )

Referenced by Spreadsheet::Sheet::onSettingDocument().

◆ getColumn()

std::string Spreadsheet::PropertySheet::getColumn ( int offset = 0 ) const

◆ getDeps() [1/2]

const std::set< std::string > & PropertySheet::getDeps ( App::CellAddress pos ) const

◆ getDeps() [2/2]

const std::set< CellAddress > & PropertySheet::getDeps ( const std::string & name ) const

Referenced by Spreadsheet::Sheet::dependsOn(), and Spreadsheet::Sheet::providesTo().

◆ getDirty()

const std::set<App::CellAddress>& Spreadsheet::PropertySheet::getDirty ( )

Referenced by Spreadsheet::Sheet::execute().

◆ getExpressions()

std::map< App::ObjectIdentifier, const App::Expression * > PropertySheet::getExpressions ( ) const

overridevirtual

Implements App::PropertyExpressionContainer.

◆ getMemSize()

unsigned int PropertySheet::getMemSize ( void ) const

overridevirtual

This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? This method is defined in Base::Persistence.

See also: Base::Persistence

Reimplemented from App::Property.

◆ getPyObject()

PyObject * PropertySheet::getPyObject ( void )

overridevirtual

This method returns the Python wrapper for a C++ object.

It's in the responsibility of the programmer to do the correct reference counting. Basically there are two ways how to implement that: Either always return a new Python object then reference counting is not a matter or return always the same Python object then the reference counter must be incremented by one. However, it's absolutely forbidden to return always the same Python object without incrementing the reference counter.

The default implementation returns 'None'.

Reimplemented from Base::BaseClass.

◆ getRow()

std::string Spreadsheet::PropertySheet::getRow ( int offset = 0 ) const

◆ getSpans()

void PropertySheet::getSpans	(	App::CellAddress	address,
		int &	rows,
		int &	cols
	)		const

References Spreadsheet::Cell::getSpans().

Referenced by Spreadsheet::Sheet::getSpans().

◆ getUsedCells()

std::set< CellAddress > PropertySheet::getUsedCells ( ) const

Referenced by Spreadsheet::Sheet::exportToFile(), Spreadsheet::Sheet::getUsedCells(), and setDirty().

◆ getValue() [1/2]

Cell * PropertySheet::getValue ( App::CellAddress key )

Referenced by copyCells(), Spreadsheet::Sheet::execute(), Spreadsheet::Sheet::getCell(), getValueFromAlias(), Spreadsheet::Sheet::hasCell(), invalidateDependants(), and Spreadsheet::Sheet::recomputeCell().

◆ getValue() [2/2]

const Cell * PropertySheet::getValue ( App::CellAddress key ) const

◆ getValueFromAlias()

const Cell * PropertySheet::getValueFromAlias ( const std::string & alias ) const

References getValue().

Referenced by Spreadsheet::Sheet::getAddressFromAlias(), isValidAlias(), and setAlias().

◆ hasSetChildValue()

void PropertySheet::hasSetChildValue ( App::Property & )

overrideprotectedvirtual

Called when a child property has changed value.

Reimplemented from App::Property.

◆ hasSetValue()

void PropertySheet::hasSetValue ( )

overrideprotectedvirtual

Gets called by all setValue() methods after the value has changed.

Reimplemented from App::PropertyLinkBase.

References App::DocumentObject::getNameInDocument(), App::DocumentObject::isRestoring(), App::PropertyLinkBase::LinkDetached, App::PropertyLinkBase::registerLabelReferences(), App::PropertyLinkBase::testFlag(), App::PropertyLinkBase::unregisterElementReference(), and App::PropertyXLinkContainer::updateDeps().

◆ insertColumns()

void PropertySheet::insertColumns	(	int	col,
		int	count
	)

References AtomicPropertyChange, App::ExpressionModifier::changed(), App::Property::getContainer(), App::DocumentObject::getDocument(), moveCell(), recomputeDependencies(), App::Document::renameObjectIdentifiers(), App::ExpressionModifier::reset(), setDirty(), and Spreadsheet::Cell::visit().

Referenced by Spreadsheet::Sheet::insertColumns().

◆ insertRows()

void PropertySheet::insertRows	(	int	row,
		int	count
	)

References AtomicPropertyChange, App::ExpressionModifier::changed(), App::Property::getContainer(), App::DocumentObject::getDocument(), moveCell(), recomputeDependencies(), App::Document::renameObjectIdentifiers(), App::ExpressionModifier::reset(), setDirty(), and Spreadsheet::Cell::visit().

Referenced by Spreadsheet::Sheet::insertRows().

◆ invalidateDependants()

void PropertySheet::invalidateDependants ( const App::DocumentObject * docObj )

References AtomicPropertyChange, App::DocumentObject::getFullName(), getValue(), setDirty(), Spreadsheet::Cell::setResolveException(), and App::Property::touch().

Referenced by onBreakLink(), Spreadsheet::SheetObserver::slotCreatedObject(), and Spreadsheet::SheetObserver::slotDeletedObject().

◆ isDirty()

bool Spreadsheet::PropertySheet::isDirty ( ) const

Referenced by Spreadsheet::Sheet::mustExecute().

◆ isHidden()

bool PropertySheet::isHidden ( App::CellAddress address ) const

◆ isMergedCell()

bool PropertySheet::isMergedCell ( App::CellAddress address ) const

Referenced by Spreadsheet::Sheet::isMergedCell().

◆ isValidAlias()

bool PropertySheet::isValidAlias ( const std::string & candidate )

References getValueFromAlias(), App::validColumn(), and App::validRow().

Referenced by Spreadsheet::Sheet::isValidAlias(), and setAlias().

◆ mergeCells()

bool PropertySheet::mergeCells	(	App::CellAddress	from,
		App::CellAddress	to
	)

References AtomicPropertyChange, clear(), App::CellAddress::col(), App::CellAddress::row(), setDirty(), and setSpans().

Referenced by Spreadsheet::Sheet::mergeCells(), moveCell(), pasteCells(), and Restore().

◆ moveCell()

void PropertySheet::moveCell	(	App::CellAddress	currPos,
		App::CellAddress	newPos,
		std::map< App::ObjectIdentifier, App::ObjectIdentifier > &	renames
	)

References Spreadsheet::Sheet::aliasRemoved(), AtomicPropertyChange, clear(), App::CellAddress::col(), Spreadsheet::Cell::getAlias(), Spreadsheet::Cell::getSpans(), mergeCells(), Spreadsheet::Cell::moveAbsolute(), App::CellAddress::row(), Spreadsheet::Cell::setAlias(), setDirty(), Spreadsheet::Cell::setSpans(), splitCell(), and App::CellAddress::toString().

Referenced by insertColumns(), insertRows(), removeColumns(), and removeRows().

◆ onAddDep()

void PropertySheet::onAddDep ( App::DocumentObject * obj )

overrideprotectedvirtual

Reimplemented from App::PropertyXLinkContainer.

◆ onBreakLink()

void PropertySheet::onBreakLink ( App::DocumentObject * obj )

overrideprotectedvirtual

Reimplemented from App::PropertyXLinkContainer.

References invalidateDependants().

◆ onContainerRestored()

void PropertySheet::onContainerRestored ( )

overridevirtual

Called before calling DocumentObject::onDocumentRestored()

This function is called after finished calling Property::afterRestore() of all properties of objects. By then, the object dependency information is assumed ready. So, unlike Property::afterRestore(), this function is called on objects with dependency order.

Reimplemented from App::Property.

References App::PropertyLinkBase::unregisterElementReference().

◆ onRelabeledDocument()

void PropertySheet::onRelabeledDocument ( const App::Document & doc )

overridevirtual

Implements App::PropertyExpressionContainer.

◆ onRemoveDep()

void PropertySheet::onRemoveDep ( App::DocumentObject * obj )

overrideprotectedvirtual

Reimplemented from App::PropertyXLinkContainer.

◆ Paste()

void PropertySheet::Paste ( const Property & from )

overridevirtual

References AtomicPropertyChange, Cell, clear(), Spreadsheet::Cell::isMarked(), recomputeDependencies(), and setDirty().

Referenced by setPyObject().

◆ pasteCells() [1/2]

void PropertySheet::pasteCells	(	Base::XMLReader &	reader,
		const App::CellAddress &	addr
	)

References AtomicPropertyChange, Spreadsheet::Sheet::cellUpdated, App::ExpressionModifier::changed(), Spreadsheet::Sheet::clear(), App::CellAddress::col(), Base::XMLReader::getAttribute(), Base::XMLReader::getAttributeAsInteger(), Spreadsheet::Sheet::getNewCell(), mergeCells(), Base::XMLReader::readElement(), recomputeDependencies(), App::CellAddress::row(), and Spreadsheet::Cell::setSpans().

Referenced by SpreadsheetGui::SheetTableView::pasteClipboard().

◆ pasteCells() [2/2]

void Spreadsheet::PropertySheet::pasteCells	(	const std::map< App::CellAddress, std::string > &	cells,
		int	rowOffset,
		int	colOffset
	)

◆ recomputeDependencies()

void PropertySheet::recomputeDependencies ( App::CellAddress key )

References AtomicPropertyChange.

Referenced by Spreadsheet::Sheet::execute(), insertColumns(), insertRows(), Paste(), pasteCells(), removeColumns(), removeRows(), renamedDocumentObject(), and renameObjectIdentifiers().

◆ referenceChanged()

bool PropertySheet::referenceChanged ( ) const

overridevirtual

Test if the element reference has changed after restore.

Reimplemented from App::PropertyLinkBase.

◆ removeColumns()

void PropertySheet::removeColumns	(	int	col,
		int	count
	)

References AtomicPropertyChange, App::ExpressionModifier::changed(), clear(), App::Property::getContainer(), App::DocumentObject::getDocument(), moveCell(), recomputeDependencies(), App::Document::renameObjectIdentifiers(), App::ExpressionModifier::reset(), setDirty(), and Spreadsheet::Cell::visit().

Referenced by Spreadsheet::Sheet::removeColumns().

◆ removeRows()

void PropertySheet::removeRows	(	int	row,
		int	count
	)

References AtomicPropertyChange, App::ExpressionModifier::changed(), clear(), App::Property::getContainer(), App::DocumentObject::getDocument(), moveCell(), recomputeDependencies(), App::Document::renameObjectIdentifiers(), App::ExpressionModifier::reset(), setDirty(), and Spreadsheet::Cell::visit().

Referenced by Spreadsheet::Sheet::removeRows().

◆ renamedDocumentObject()

void PropertySheet::renamedDocumentObject ( const App::DocumentObject * docObj )

References recomputeDependencies(), and setDirty().

Referenced by Spreadsheet::SheetObserver::slotChangedObject().

◆ renameObjectIdentifiers()

void PropertySheet::renameObjectIdentifiers ( const std::map< App::ObjectIdentifier, App::ObjectIdentifier > & paths )

References recomputeDependencies(), and setDirty().

Referenced by Spreadsheet::Sheet::renameObjectIdentifiers().

◆ Restore()

void PropertySheet::Restore ( Base::XMLReader & )

overridevirtual

This method is used to restore properties from an XML document.

It uses the XMLReader class, which bases on SAX, to read the in Save() written information. Again the Vector as an example:

void PropertyVector::Restore(Base::XMLReader &reader)
{
  // read my Element
  reader.readElement("PropertyVector");
  // get the value of my Attribute
  _cVec.x = reader.getAttributeAsFloat("valueX");
  _cVec.y = reader.getAttributeAsFloat("valueY");
  _cVec.z = reader.getAttributeAsFloat("valueZ");
}

Reimplemented from App::PropertyXLinkContainer.

References AtomicPropertyChange, createCell(), Base::XMLReader::getAttribute(), Base::XMLReader::getAttributeAsInteger(), Spreadsheet::Cell::getSpans(), Base::XMLReader::hasAttribute(), mergeCells(), Base::XMLReader::readElement(), Base::XMLReader::readEndElement(), and Spreadsheet::Cell::restore().

◆ Save()

void PropertySheet::Save ( Base::Writer & ) const

overridevirtual

This method is used to save properties to an XML document.

A good example you'll find in PropertyStandard.cpp, e.g. the vector:

void PropertyVector::Save (Writer &writer) const
{
   writer << writer.ind() << "<PropertyVector valueX=\"" <<  _cVec.x <<
                                          "\" valueY=\"" <<  _cVec.y <<
                                          "\" valueZ=\"" <<  _cVec.z <<"\"/>" << endl;
}

The writer.ind() expression writes the indentation, just for pretty printing of the XML. As you see, the writing of the XML document is not done with a DOM implementation because of performance reasons. Therefore the programmer has to take care that a valid XML document is written. This means closing tags and writing UTF-8.