The Properties class represents a persistent set of properties. The Properties can be saved to a file (Ex.: .json) or loaded from a file (Ex.: .json). Also used for interaction, with user or other classes of this module, to change state of a MVC Component. More...

#include <Properties.h>

Public Member Functions
virtual bool	addProperty (Property property)
	Adds the specified property to the set of properties for this object. More...

virtual bool	clear ()
	Clear set of properties of this object. More...

virtual bool	contains (Property property)
	Checks if the property is contained within the set of properties. More...

virtual Property	contains (std::string name)
	Checks if the name is contained within the set of properties. More...

virtual int	getHashCode ()
	Returns the hashcode of a MVC component. More...

virtual std::string	getObjectName ()
	Returns object name that owns these properties. More...

virtual std::vector< Property >	getProperties ()
	Returns set of all properties. More...

virtual EnumType *	getTypeObj ()
	Returns object type that owns these properties. More...

virtual bool	hasWindows ()

	Properties (std::string objectName, EnumType *type=0, int hashCode=0)
	Constructor. More...

virtual bool	removeProperty (std::string name)
	Removes a property from the set of properties of this object. More...

virtual void	setHashCode (int hashCode)
	Sets the hashcode of a MVC component. More...

virtual void	setHasWindows (bool windows)

virtual void	setObjectName (std::string name)
	Sets object name that owns these properties. More...

virtual void	setTypeObj (EnumType *type)
	Sets object type that owns these properties. More...

virtual	~Properties (void)
	Destructor. More...

Protected Attributes
int	m_hashcode

bool	m_hasWindows

std::string	m_objName
	Object name that owns these properties. More...

std::vector< Property >	m_properties
	set of properties for this object More...

EnumType *	m_typeObj
	Object type that owns these properties. More...

Detailed Description

The Properties class represents a persistent set of properties. The Properties can be saved to a file (Ex.: .json) or loaded from a file (Ex.: .json). Also used for interaction, with user or other classes of this module, to change state of a MVC Component.

Definition at line 52 of file Properties.h.

Constructor & Destructor Documentation

te::layout::Properties::Properties	(	std::string	objectName,
		EnumType *	type = `0`,
		int	hashCode = `0`
	)

inline

Constructor.

Parameters

objectName	Object name that owns these properties
type	Object type that owns these properties

Definition at line 181 of file Properties.h.

te::layout::Properties::~Properties ( void )

inlinevirtual

Destructor.

Definition at line 189 of file Properties.h.

Member Function Documentation

bool te::layout::Properties::addProperty ( Property property )

inlinevirtual

Adds the specified property to the set of properties for this object.

Parameters

property specified property

Returns: true if add, false otherwise

Definition at line 193 of file Properties.h.

References m_properties.

Referenced by te::layout::ItemModelObservable::addChildrenProperties(), te::layout::MenuBuilder::changePropertyValue(), te::layout::PropertyBrowser::getProperties(), te::layout::JSON::retrieve(), te::layout::PropertiesUtils::sameProperties(), te::layout::PropertiesOutside::sendPropertyToSelectedItem(), te::layout::PropertiesOutside::sendPropertyToSelectedItems(), and te::layout::GridSettingsModel::updateProperty().

bool te::layout::Properties::clear ( )

inlinevirtual

Clear set of properties of this object.

Returns: true if clear, false otherwise

Definition at line 225 of file Properties.h.

References m_properties.

Referenced by te::layout::MapLayerChoiceModel::getProperties(), te::layout::TextGridSettingsModel::getProperties(), te::layout::PageSetupModel::getProperties(), te::layout::SystematicScaleModel::getProperties(), te::layout::ItemModelObservable::getProperties(), te::layout::OutsideModelObservable::getProperties(), te::layout::OutsideModelObservable::getPublicProperties(), te::layout::ItemModelObservable::getPublicProperties(), and te::layout::ChangePropertyCommand::~ChangePropertyCommand().

bool te::layout::Properties::contains ( Property property )

inlinevirtual

Checks if the property is contained within the set of properties.

Parameters

property

Returns: true if contained, false otherwise

Definition at line 251 of file Properties.h.

References m_properties.

te::layout::Property te::layout::Properties::contains ( std::string name )

inlinevirtual

Checks if the name is contained within the set of properties.

Parameters

name	name of the property

Returns: true if contained, false otherwise

Definition at line 263 of file Properties.h.

References m_properties.

int te::layout::Properties::getHashCode ( )

inlinevirtual

Returns the hashcode of a MVC component.

Returns: hashCode

Definition at line 290 of file Properties.h.

std::string te::layout::Properties::getObjectName ( )

inlinevirtual

Returns object name that owns these properties.

Returns: object name that owns these properties

Definition at line 231 of file Properties.h.

References m_objName.

Referenced by te::layout::MenuBuilder::changePropertyValue(), te::layout::PropertiesOutside::itemsSelected(), te::layout::PropertiesOutside::sendPropertyToSelectedItem(), and te::layout::PropertiesOutside::sendPropertyToSelectedItems().

std::vector< Property > te::layout::Properties::getProperties ( )

inlinevirtual

Returns set of all properties.

Returns: set of all properties

Definition at line 220 of file Properties.h.

References m_properties.

Referenced by te::layout::ItemModelObservable::addChildrenProperties(), te::layout::ChangePropertyCommand::equals(), te::layout::ItemUtils::getGridMapProperties(), te::layout::OutsideObserver::getProperties(), te::layout::PropertiesOutside::itemsSelected(), te::layout::JSON::loadFromProperties(), te::layout::PropertiesUtils::sameProperties(), te::layout::PropertyBrowser::updateProperties(), and te::layout::OutsideModelObservable::updateProperties().

te::layout::EnumType * te::layout::Properties::getTypeObj ( )

inlinevirtual

Returns object type that owns these properties.

Returns: object type that owns these properties

Definition at line 241 of file Properties.h.

References m_typeObj.

Referenced by te::layout::MenuBuilder::changePropertyValue(), te::layout::GridSettingsModel::containsGrid(), te::layout::JSON::loadFromProperties(), te::layout::BuildGraphicsItem::rebuildItem(), te::layout::PropertiesOutside::sendPropertyToSelectedItem(), and te::layout::PropertiesOutside::sendPropertyToSelectedItems().

bool te::layout::Properties::hasWindows ( )

inlinevirtual

Returns

Definition at line 285 of file Properties.h.

Referenced by te::layout::PropertiesUtils::getAllProperties(), and te::layout::PropertiesUtils::intersection().

bool te::layout::Properties::removeProperty ( std::string name )

inlinevirtual

Removes a property from the set of properties of this object.

Parameters

property specified property

Returns: true if remove, false otherwise

Definition at line 204 of file Properties.h.

References m_properties.

Referenced by te::layout::GridSettingsModel::updateProperty().

void te::layout::Properties::setHashCode ( int hashCode )

inlinevirtual

Sets the hashcode of a MVC component.

Returns: hashCode

Definition at line 295 of file Properties.h.

Referenced by te::layout::MenuBuilder::changePropertyValue(), te::layout::ItemModelObservable::ItemModelObservable(), and te::layout::OutsideModelObservable::OutsideModelObservable().

void te::layout::Properties::setHasWindows ( bool windows )

inlinevirtual

Parameters

Definition at line 280 of file Properties.h.

Referenced by te::layout::ImageModel::ImageModel(), and te::layout::PropertiesOutside::itemsSelected().

void te::layout::Properties::setObjectName ( std::string name )

inlinevirtual

Sets object name that owns these properties.

Parameters

object name that owns these properties

Definition at line 236 of file Properties.h.

References m_objName.

Referenced by te::layout::MenuBuilder::changePropertyValue(), te::layout::PropertiesOutside::sendPropertyToSelectedItem(), and te::layout::PropertiesOutside::sendPropertyToSelectedItems().

void te::layout::Properties::setTypeObj ( EnumType * type )

inlinevirtual

Sets object type that owns these properties.

Parameters

object type that owns these properties

Definition at line 246 of file Properties.h.

References m_typeObj.

Referenced by te::layout::MenuBuilder::changePropertyValue(), te::layout::JSON::retrieve(), te::layout::PropertiesOutside::sendPropertyToSelectedItem(), and te::layout::PropertiesOutside::sendPropertyToSelectedItems().

Member Data Documentation

int te::layout::Properties::m_hashcode

protected

Definition at line 177 of file Properties.h.

bool te::layout::Properties::m_hasWindows

protected

Definition at line 176 of file Properties.h.

std::string te::layout::Properties::m_objName

protected

Object name that owns these properties.

Definition at line 174 of file Properties.h.

Referenced by getObjectName(), and setObjectName().

std::vector<Property> te::layout::Properties::m_properties

protected

set of properties for this object

Definition at line 173 of file Properties.h.

Referenced by addProperty(), clear(), contains(), getProperties(), and removeProperty().

EnumType* te::layout::Properties::m_typeObj

protected

Object type that owns these properties.

Definition at line 175 of file Properties.h.

Referenced by getTypeObj(), and setTypeObj().

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

C:/TL5_2015_release/terralib5/src/terralib/layout/core/property/Properties.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation