UserAttribute Class Reference

Represent a line width of a path. This may be a simple stroking operator such as a constant line width, or a complex one such as variable line widths or an airbrush stroke operator. (I'd say it stores a "key" string and an associated "value" string for implementation of URLs and other such stuff, but if you say it stores a line width, who am I to argue? ;-). More...

#include <userattr.h>

Inheritance diagram for UserAttribute:

List of all members.

Public Member Functions
	UserAttribute ()
UserAttribute &	operator= (const UserAttribute &other)
	Assignment operator for UserAttributes.
virtual void	Restore (RenderRegion *, BOOL)
	Again, restoring a User Attribute does nothing.
virtual void	Render (RenderRegion *, BOOL Temp=FALSE)
	Rendering a User Attribute does nothing. That's what this function does.
virtual NodeAttribute *	MakeNode ()
	Make a AttrUser node from this line width attribute.
BOOL	IsDifferent (AttributeValue *pAttr)
	See base class version.
virtual void	SimpleCopy (AttributeValue *)
	Copies both bits of the data from pValue.
virtual BOOL	Blend (BlendAttrParam *pBlendParam)
	Blends this attr val with the attr val held in pBlendParam.
virtual BOOL	RenderStroke (RenderRegion *, Path *)
Static Public Member Functions
static BOOL	Init ()
	There's no need for this function at the moment but I'll leave it in in case someone needs it in the future.
Public Attributes
StringBase	Key
StringBase	LongKey
StringBase	Value
const Style *	m_pStyle

---

Detailed Description

Represent a line width of a path. This may be a simple stroking operator such as a constant line width, or a complex one such as variable line widths or an airbrush stroke operator. (I'd say it stores a "key" string and an associated "value" string for implementation of URLs and other such stuff, but if you say it stores a line width, who am I to argue? ;-).

Author:

Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> (Actually, it was more likely to be Graham, cos Tim quit a few months before)

Date:

15/06/94 (More like mid '96 if you ask me)

Definition at line 125 of file userattr.h.

---

Constructor & Destructor Documentation

UserAttribute::UserAttribute (   )

FUNCTIONS FOR THE UserATTRIBUTE CLASS (Graham 18/8/96) Definition at line 147 of file userattr.cpp. : m_pStyle(0) { // To ensure default constructed UserAttributes can be copied, alloc the strings. if (!Key.Alloc(0) || !LongKey.Alloc(0) || !Value.Alloc(0)) return; }

---

Member Function Documentation

BOOL UserAttribute::Blend (  BlendAttrParam *  pBlendParam  )  [virtual]

Blends this attr val with the attr val held in pBlendParam. Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> from Markn Date: 15/8/96 Parameters: pBlendParam  = ptr to param holding all data needed for the attr val to blend [INPUTS] if  TRUE returned, pBlendParam->GetBlendedAttrVal() will get ptr to the blended attr val [OUTPUTS] if FALSE returned, pBlendParam->GetBlendedAttrVal() will return NULL Returns: TRUE if successful, FALSE otherwaie See also: - Reimplemented from AttributeValue. Definition at line 344 of file userattr.cpp. { // Check entry param ERROR3IF(pBlendParam == NULL,"NULL entry param"); if (pBlendParam == NULL) return FALSE; // Check that the pointer to the other User attr val is not NULL, and is a UserAttribute UserAttribute* pOtherUserAttr = (UserAttribute*) pBlendParam->GetOtherAttrVal(); ERROR3IF(pOtherUserAttr == NULL,"NULL other attr val"); ERROR3IF(!IS_A(pOtherUserAttr, UserAttribute),"other attr val not a user attr"); if (pOtherUserAttr == NULL || !IS_A(pOtherUserAttr, UserAttribute)) return FALSE; //Graham: Here's the change. If the Keys of the attributes are not the same, we must //not blend these attributes. if (Key != pOtherUserAttr->Key && LongKey != pOtherUserAttr->LongKey) { return FALSE; } // Get a new UserAttribute to hold the blended version, (return FALSE if this fails) UserAttribute* pBlendedUserAttr = new UserAttribute; if (pBlendedUserAttr == NULL) return FALSE; //Graham: For blending two User Attributes with the same Key, we simply //use the first User Attribute for the first half of the blend, and the //second User Attribute for the second half of the blend. StringBase* pStr; if (pBlendParam->GetBlendRatio() < 0.5) pStr = &Value; else pStr = &(pOtherUserAttr->Value); ERRORIF(!pBlendedUserAttr->Value.Alloc(pStr->Length()), _R(IDE_NOMORE_MEMORY), FALSE); pBlendedUserAttr->Value = *pStr; // Store the ptr to the new blended User width attr val pBlendParam->SetBlendedAttrVal(pBlendedUserAttr); return TRUE; }

BOOL UserAttribute::Init (  void   )  [static]

There's no need for this function at the moment but I'll leave it in in case someone needs it in the future. Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 14/8/96 Returns: TRUE - initialised ok; FALSE if not. This function usually registers Default Attributes (see commented out code below). There's never a need to register a Default User Attribute. Returns: Errors: None See also: AttributeManager Reimplemented from SimpleCCObject. Definition at line 202 of file userattr.cpp. { UserAttribute *pAttr = new UserAttribute; if (pAttr == NULL) return FALSE; UINT32 ID = AttributeManager::RegisterDefaultAttribute(CC_RUNTIME_CLASS(NodeRenderableInk), pAttr); if (ID == ATTR_BAD_ID) return FALSE; ENSURE(ID == ATTR_USERATTRIBUTE, "Incorrect ID for attribute!"); return TRUE; }

BOOL UserAttribute::IsDifferent (  AttributeValue *  pAttr  )  [virtual]

See base class version. Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> from Tim Date: 12/04/94 Returns: Errors: The two attributes are not of the same type. See also: AttributeValue::IsDifferent Reimplemented from AttributeValue. Definition at line 315 of file userattr.cpp. { ENSURE_NOT_NULL(pAttr); ENSURE(GetRuntimeClass() == pAttr->GetRuntimeClass(), "Different attribute types in AttributeValue::IsDifferent()"); ENSURE_KIND(pAttr, UserAttribute); UserAttribute* const pUserAttrVal = (UserAttribute*)pAttr; // LongKey should always start with Key return pUserAttrVal->LongKey != LongKey || pUserAttrVal->Value != Value; }

NodeAttribute * UserAttribute::MakeNode (   )  [virtual]

Make a AttrUser node from this line width attribute. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 11/04/94 Returns: Pointer to the new node, or NULL if out of memory. Errors: Out of memory See also: AttributeValue::MakeNode Reimplemented from AttributeValue. Definition at line 291 of file userattr.cpp. { // Create new attribute node AttrUser *pAttr = new AttrUser(); // Copy attribute value into the new node. pAttr->Value.SimpleCopy(this); // Return the new node return pAttr; }

UserAttribute & UserAttribute::operator= (  const UserAttribute &  other  )

Assignment operator for UserAttributes. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 26/9/99 Returns: Errors: _R(IDE_NOMORE_MEMORY) Notes: *DOESN'T* COPY THE m_pStyle MEMBER! What the hell is that doing in this class, anyway?? See also: UserAttribute::SimpleCopy; AttrUser::CopyNodeContents Definition at line 168 of file userattr.cpp. { if (Key.Alloc(other.Key.Length()) && LongKey.Alloc(other.LongKey.Length()) && Value.Alloc(other.Value.Length())) { Key = other.Key; LongKey = other.LongKey; Value = other.Value; } return *this; }

void UserAttribute::Render (  RenderRegion *  pRegion, BOOL  Temp = FALSE )  [virtual]

Rendering a User Attribute does nothing. That's what this function does. Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 14/8/96 Parameters: pRegion  - the render region to render this attribute into. [INPUTS] See also: UserAttribute; RenderStack; AttributeValue; NodeAttribute; ValueAttribute::Restore; ValueAttribute::SimpleCopy; AttributeValue::Render; AttributeValue::Restore; AttributeValue::SimpleCopy Implements AttributeValue. Definition at line 231 of file userattr.cpp. { //Do nothing }

virtual BOOL UserAttribute::RenderStroke (  RenderRegion *  , Path *  )  [inline, virtual]

Definition at line 144 of file userattr.h. { return FALSE; }

void UserAttribute::Restore (  RenderRegion *  pRegion, BOOL  Temp )  [virtual]

Again, restoring a User Attribute does nothing. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 03/02/94 Parameters: pRegion  - the render region to restore the attribute into. [INPUTS] Temp - TRUE if this is a temporary attribute, FALSE if it is permanent (e.g. it's in a document tree). See also: UserAttribute; RenderStack; AttributeValue; NodeAttribute; ValueAttribute::Render; ValueAttribute::SimpleCopy; AttributeValue::Render; AttributeValue::Restore; AttributeValue::SimpleCopy Implements AttributeValue. Definition at line 253 of file userattr.cpp. { // Do nothing }

void UserAttribute::SimpleCopy (  AttributeValue *  pValue  )  [virtual]

Copies both bits of the data from pValue. Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 16/8/96 Parameters: pValue  - pointer to the AttributeValue to copy. [INPUTS] See also: ValueAttribute; RenderStack; AttributeValue; NodeAttribute; ValueAttribute::Render; ValueAttribute::Restore; AttributeValue::Render; AttributeValue::Restore; AttributeValue::SimpleCopy Implements AttributeValue. Definition at line 272 of file userattr.cpp. { *this = *((UserAttribute*) pValue); }

---

Member Data Documentation

StringBase UserAttribute::Key

Definition at line 146 of file userattr.h.

StringBase UserAttribute::LongKey

Definition at line 147 of file userattr.h.

const Style* UserAttribute::m_pStyle

Definition at line 149 of file userattr.h.

StringBase UserAttribute::Value

Definition at line 148 of file userattr.h.

---

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

• Kernel/userattr.h (r1785/r751)
• Kernel/userattr.cpp (r1785/r1282)

---