WSF
Public Member Functions | Friends | List of all members
wizard::AttributeSet Class Reference

#include <AttributeSet.hpp>

Public Member Functions

 AttributeSet (const std::string &aName)
 AttributeSet (const AttributeSet &aSrc)
 Copy the sub-tree of attributes, leaving owner null.
 ~AttributeSet ()
void Apply (const AttributeSet &aOtherSet)
void WriteXML (const std::string &aName, UtQtXmlWriter &aWriter) const
void ReadXML (UtQtXmlElementReader &aReader)
bool ReadSingleXML (UtQtXmlElementReader &aReader)
 Read the top-level attribute set from a single entry.
std::string ToString ()
void SetValue (const std::string &aName, const UtVariant &aValue)
bool GetValue (const std::string &aName, UtVariant &aValue) const
UtVariant GetValue (const std::string &aName) const
bool GetBool (const std::string &aName, bool aDefautlValue) const
double GetDouble (const std::string &aName, double aDefaultValue) const
int GetInt (const std::string &aName, int aDefaultValue) const
std::string GetString (const std::string &aName, const std::string &aDefaultValue) const
AttributeSet & Child (const std::string &aChildName)
AttributeSet * FindChild (const std::string &aChildName)
bool RenameChild (const std::string &aCurrentName, const std::string &aNewName)
bool Rename (const std::string &aNewName)
bool RemoveChild (const std::string &aChildName)
bool HasAttribute (const std::string &aName) const
bool HasChild (const std::string &aChildName) const
void NotifyOwnersOfChange ()
AttributeSet * GetParent ()
const std::string & GetAttributeName () const

Friends

class AttributeOwner

Detailed Description

A set of attributes Attribute values are stored as a UtVariant Each attribute has a name Contains any number of children with unique names The attribute set may be owned by a AttributeOwner

Constructor & Destructor Documentation

◆ AttributeSet() [1/2]

wizard::AttributeSet::AttributeSet ( const std::string & aName)
explicit

Referenced by Apply(), AttributeOwner, AttributeSet(), Child(), GetParent(), and RenameChild().

◆ AttributeSet() [2/2]

wizard::AttributeSet::AttributeSet ( const AttributeSet & aSrc)

Copy the sub-tree of attributes, leaving owner null.

References AttributeSet().

◆ ~AttributeSet()

wizard::AttributeSet::~AttributeSet ( )

Member Function Documentation

◆ Apply()

void wizard::AttributeSet::Apply ( const AttributeSet & aOtherSet)

References AttributeSet(), and Child().

Referenced by AttributeOwner.

◆ Child()

wizard::AttributeSet & wizard::AttributeSet::Child ( const std::string & aChildName)

References AttributeSet().

Referenced by Apply(), AttributeOwner, wizard::Project::GetOptions(), and ReadXML().

◆ FindChild()

wizard::AttributeSet * wizard::AttributeSet::FindChild ( const std::string & aChildName)

Referenced by AttributeOwner, wizard::Project::FindOptions(), and RenameChild().

◆ GetAttributeName()

const std::string & wizard::AttributeSet::GetAttributeName ( ) const
inline

◆ GetBool()

bool wizard::AttributeSet::GetBool ( const std::string & aName,
bool aDefautlValue ) const

Referenced by AttributeOwner.

◆ GetDouble()

double wizard::AttributeSet::GetDouble ( const std::string & aName,
double aDefaultValue ) const

Referenced by AttributeOwner.

◆ GetInt()

int wizard::AttributeSet::GetInt ( const std::string & aName,
int aDefaultValue ) const

Referenced by AttributeOwner.

◆ GetParent()

AttributeSet * wizard::AttributeSet::GetParent ( )
inline

References AttributeSet().

◆ GetString()

std::string wizard::AttributeSet::GetString ( const std::string & aName,
const std::string & aDefaultValue ) const

Referenced by AttributeOwner.

◆ GetValue() [1/2]

UtVariant wizard::AttributeSet::GetValue ( const std::string & aName) const

◆ GetValue() [2/2]

bool wizard::AttributeSet::GetValue ( const std::string & aName,
UtVariant & aValue ) const

Referenced by AttributeOwner.

◆ HasAttribute()

bool wizard::AttributeSet::HasAttribute ( const std::string & aName) const

Referenced by AttributeOwner.

◆ HasChild()

bool wizard::AttributeSet::HasChild ( const std::string & aChildName) const

Referenced by AttributeOwner.

◆ NotifyOwnersOfChange()

void wizard::AttributeSet::NotifyOwnersOfChange ( )

Referenced by AttributeOwner.

◆ ReadSingleXML()

bool wizard::AttributeSet::ReadSingleXML ( UtQtXmlElementReader & aReader)

Read the top-level attribute set from a single entry.

References ReadXML().

Referenced by AttributeOwner.

◆ ReadXML()

void wizard::AttributeSet::ReadXML ( UtQtXmlElementReader & aReader)

References Child(), ReadVariant(), and SetValue().

Referenced by AttributeOwner, and ReadSingleXML().

◆ RemoveChild()

bool wizard::AttributeSet::RemoveChild ( const std::string & aChildName)

Referenced by AttributeOwner.

◆ Rename()

bool wizard::AttributeSet::Rename ( const std::string & aNewName)

Referenced by AttributeOwner, and wizard::Project::HandleProxyNodeMoved().

◆ RenameChild()

bool wizard::AttributeSet::RenameChild ( const std::string & aCurrentName,
const std::string & aNewName )

References AttributeSet(), and FindChild().

Referenced by AttributeOwner.

◆ SetValue()

void wizard::AttributeSet::SetValue ( const std::string & aName,
const UtVariant & aValue )

Referenced by AttributeOwner, and ReadXML().

◆ ToString()

std::string wizard::AttributeSet::ToString ( )

References WriteXML().

Referenced by AttributeOwner.

◆ WriteXML()

void wizard::AttributeSet::WriteXML ( const std::string & aName,
UtQtXmlWriter & aWriter ) const

References WriteVariant().

Referenced by AttributeOwner, and ToString().

◆ AttributeOwner

friend class AttributeOwner
friend

References Apply(), AttributeOwner, AttributeSet(), Child(), FindChild(), GetBool(), GetDouble(), GetInt(), GetString(), GetValue(), HasAttribute(), HasChild(), NotifyOwnersOfChange(), ReadSingleXML(), ReadXML(), RemoveChild(), Rename(), RenameChild(), SetValue(), ToString(), and WriteXML().

Referenced by AttributeOwner.

The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved