SingletonAppliedAttribute Class Reference

Represents an applied attribute of which there is only one for the objects given by the iterator. More...

#include <attraggl.h>

Inheritance diagram for SingletonAppliedAttribute:

List of all members.

Public Member Functions
	SingletonAppliedAttribute (NodeAttribute &TheAttribute)
	This constructor tries to create a UserInterface in the form of a VisibleUserAttribute so the user can alter the attributes' contents.
	SingletonAppliedAttribute (VisibleAttribute &TheVisibleAttribute)
	This constructor is used for new VisibleAttributes (i.e., ones that haven't yet been applied).
	SingletonAppliedAttribute (const SingletonAppliedAttribute &Other)
virtual	~SingletonAppliedAttribute ()
	Destructor removes any internal heap muck.
virtual BOOL	Display (DialogOp &Dialog)
	This SingletonAppliedAttribute appears in the Wizard Properties dialog as a "Used Property". When selected it displays its innards.
virtual void	Hide ()
	This SingletonAppliedAttribute appears in the Wizard Properties dialog as a "Used Property". When de-selected it hides what it was displaying and makes any updates to the actual VisibleAttribute.
virtual StringBase &	GetText (StringBase &Description) const
	Provides the text that goes in any UI.
virtual AttributeIdentifier	GetAttrID () const
virtual BOOL	ApplyAttribute (Operation &OpToApplyWith)
	This is called when the AppliedAttribute should apply itself to the selection.
virtual VisibleAttribute *	GetVisibleAttribute ()
Private Member Functions
	CC_DECLARE_MEMDUMP (SingletonAppliedAttribute)
Private Attributes
VisibleAttribute *	m_pVisibleAttribute
String_128	m_AttrID
DialogOp *	m_pDialog

---

Detailed Description

Represents an applied attribute of which there is only one for the objects given by the iterator.

Author:

Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com>

Date:

01/07/97

Definition at line 339 of file attraggl.h.

---

Constructor & Destructor Documentation

SingletonAppliedAttribute::SingletonAppliedAttribute (  NodeAttribute &  TheAttribute  )

This constructor tries to create a UserInterface in the form of a VisibleUserAttribute so the user can alter the attributes' contents. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 09/06/97 Notes: If this constructor fails there will be no user interface for the NodeAttribute. Definition at line 836 of file attraggl.cpp. : m_AttrID(TheAttribute.GetAttributeClassID()) { m_pVisibleAttribute = TheAttribute.CreateVisibleAttribute(); if (m_pVisibleAttribute != NULL) { m_pVisibleAttribute->MarkAsUsed(); } m_pDialog = NULL; }

SingletonAppliedAttribute::SingletonAppliedAttribute (  VisibleAttribute &  TheVisibleAttribute  )

This constructor is used for new VisibleAttributes (i.e., ones that haven't yet been applied). Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 09/06/97 Parameters: The  VisibleAttribute that is the one and only attribute with the associated [INPUTS] AttributeIdentifier (from GetAttributeClassID()) applied to the node (or will be) Notes: If this constructor fails there will be no user interface for the VisibleAttribute. Definition at line 867 of file attraggl.cpp. : m_AttrID(NullString) { m_pVisibleAttribute = &TheVisibleAttribute; // Create us a quick NodeAttribute so we can get the ClassID thing NodeAttribute* pAttrib = m_pVisibleAttribute->CreateNewAttribute(); if (pAttrib != NULL) { m_AttrID = pAttrib->GetAttributeClassID(); delete pAttrib; } m_pDialog = NULL; }

SingletonAppliedAttribute::SingletonAppliedAttribute (  const SingletonAppliedAttribute &  Other  )  [inline]

Definition at line 347 of file attraggl.h. : m_AttrID(NonConstNullString) { TRACE( wxT("SingletonAppliedAttribute copy constructor not implemented\n") ); }

SingletonAppliedAttribute::~SingletonAppliedAttribute (   )  [virtual]

Destructor removes any internal heap muck. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 09/06/97 Definition at line 894 of file attraggl.cpp. { delete m_pVisibleAttribute; m_pVisibleAttribute = NULL; }

---

Member Function Documentation

BOOL SingletonAppliedAttribute::ApplyAttribute (  Operation &  OpToApplyWith  )  [virtual]

This is called when the AppliedAttribute should apply itself to the selection. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 09/06/97 Parameters: OpToApplyWith,:  This is quite useless 'cos we need to apply an op to an [INPUTS] object. Unfortunately there's no hierarchy in the OpParam class. Notes: Always uses OpApplyAttribToSelected Implements AppliedAttribute. Definition at line 1038 of file attraggl.cpp. { BOOL Ok = TRUE; if (GetVisibleAttribute() != NULL) { NodeAttribute* pAttrib = GetVisibleAttribute()->CreateNewAttribute(); Ok = (pAttrib != NULL); if (Ok) { // Obtain a pointer to the op descriptor for the attribute operation OpDescriptor* const pOpDesc = OpDescriptor::FindOpDescriptor(CC_RUNTIME_CLASS(OpApplyAttribToSelected)); ENSURE_NOT_NULL(pOpDesc); // Invoke the operation, passing Attrib as a parameter OpParam Param( pAttrib, TRUE ); pOpDesc->Invoke( &Param ); // TRUE for undo } delete pAttrib; pAttrib = NULL; } else { TRACE( _T("SingletonAppliedAttribute::ApplyAttribute() : NULL Members") ); } return Ok; }

SingletonAppliedAttribute::CC_DECLARE_MEMDUMP (  SingletonAppliedAttribute   )  [private]

BOOL SingletonAppliedAttribute::Display (  DialogOp &  Dialog  )  [virtual]

This SingletonAppliedAttribute appears in the Wizard Properties dialog as a "Used Property". When selected it displays its innards. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 09/06/97 Parameters: Dialog,:  The dialog on which to display this SingletonAppliedAttribute [INPUTS] Returns: TRUE if it succeeded in doing what it wanted, FALSE if it didn't Notes: The given DialogOp must be derived from TemplateDialog. SingletonAppliedAttribute delegates the work to the VisibleAttribute that is the singleton in the selection. Reimplemented from VisibleListItem. Definition at line 918 of file attraggl.cpp. { PORTNOTETRACE("dialog","SingletonAppliedAttribute::Display - do nothing"); #ifndef EXCLUDE_FROM_XARALX BOOL Ok = TRUE; if (m_pVisibleAttribute != NULL) { m_pVisibleAttribute->Display(Dialog); // god, it's another bodge...it will get sorted, honest! // if the user changes the text then we'll enable the apply button // but we need to make sure we don't interpret our own internal changes // We disable the message processing (in TemplateDialog) in Hide() m_pDialog = &Dialog; ENSURE_KIND((&Dialog), TemplateDialog); TemplateDialog& BetterBeThisDialog = (TemplateDialog&)Dialog; BetterBeThisDialog.SetUserCanModifyQuestion(TRUE); Ok = m_pVisibleAttribute->Interact(Dialog); } else { TRACE(_T("SingletonAppliedAttribute::Display() : NULL Members")); Ok = FALSE; } return Ok; #endif return FALSE; }

virtual AttributeIdentifier SingletonAppliedAttribute::GetAttrID (   )  const [inline, virtual]

Implements AppliedAttribute. Definition at line 362 of file attraggl.h. { return m_AttrID; }

StringBase & SingletonAppliedAttribute::GetText (  StringBase &  Description  )  const [virtual]

Provides the text that goes in any UI. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 09/06/97 Notes: The Wizard Properties dialog uses this text in the "Used Property" list. SingletonAppliedAttribute gets the text from the actual VisibleAttribute that is the Singleton in the selection. Implements VisibleListItem. Definition at line 1008 of file attraggl.cpp. { if (m_pVisibleAttribute != NULL) { return m_pVisibleAttribute->GetText(Description); } else { return Description = String_256(_R(IDS_ERRORS_UNKNOWN)); } }

virtual VisibleAttribute* SingletonAppliedAttribute::GetVisibleAttribute (   )  [inline, virtual]

Implements AppliedAttribute. Definition at line 364 of file attraggl.h. { return m_pVisibleAttribute; }

void SingletonAppliedAttribute::Hide (   )  [virtual]

This SingletonAppliedAttribute appears in the Wizard Properties dialog as a "Used Property". When de-selected it hides what it was displaying and makes any updates to the actual VisibleAttribute. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 09/06/97 Notes: SingletonAppliedAttribute delegates the work to the VisibleAttribute that is the singleton in the selection. Reimplemented from VisibleListItem. Definition at line 968 of file attraggl.cpp. { PORTNOTETRACE("dialog","SingletonAppliedAttribute::Hide - do nothing"); #ifndef EXCLUDE_FROM_XARALX if (m_pDialog != NULL && m_pVisibleAttribute != NULL) { ENSURE_KIND(m_pDialog, TemplateDialog); // Disable the processing of TEXT_CHANGED message (in TemplateDialog) // otherwise we end up processing our own changes TemplateDialog* pBetterBeThisDialog = (TemplateDialog*)m_pDialog; pBetterBeThisDialog->SetUserCanModifyQuestion(FALSE); m_pVisibleAttribute->Hide(); // we'll say we're not on a dialog any more so we can ignore further requests m_pDialog = NULL; } else { TRACE(_T("SingletonAppliedAttribute::Hide() : NULL Members")); } #endif }

---

Member Data Documentation

String_128 SingletonAppliedAttribute::m_AttrID [private]

Definition at line 369 of file attraggl.h.

DialogOp* SingletonAppliedAttribute::m_pDialog [private]

Definition at line 370 of file attraggl.h.

VisibleAttribute* SingletonAppliedAttribute::m_pVisibleAttribute [private]

Definition at line 368 of file attraggl.h.

---

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

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

---