wizard::ChangeWrapper Class Reference

#include <ChangeWrapper.hpp>

Public Member Functions
	ChangeWrapper (wizard::Editor *aEditorPtr, UtTextDocumentRange aRange)
	ChangeWrapper (WsfPProxyNode aProxyNode)
	ChangeWrapper (wizard::Platform *aPlatformPtr, WsfPProxyNode aProxyNode)
	ChangeWrapper (wizard::Editor *aEditorPtr, vespa::VaAttachment *aAttachmentPtr, UtTextDocumentRange aRange)
	ChangeWrapper (wizard::Editor *aEditorPtr, wizard::Platform *aPlatformPtr, vespa::VaAttachment *aAttachmentPtr, WsfPProxyNode aProxyNode)
	ChangeWrapper (wizard::Platform *aPlatformPtr, vespa::VaAttachment *aAttachmentPtr, WsfPProxyNode aProxyNode)
	ChangeWrapper (wizard::Platform *aPlatformPtr, wkf::Waypoint *aWaypointPtr, WsfPProxyNode aProxyNode)
	ChangeWrapper (wizard::Platform *aPlatformPtr, wkf::ZonePoint *aZonePointPtr, WsfPProxyNode aProxyNode)
	ChangeWrapper (wkf::PointOfInterest *aPointOfInterestPtr, WsfPProxyNode aProxyNode)
bool	operator< (const ChangeWrapper &aRHS) const noexcept

Get access to the objects that this ChangeWrapper wraps
wkf::AttachmentRoute *	GetRoute () const noexcept
wkf::Waypoint *	GetWaypoint () const noexcept
wkf::AttachmentZone *	GetZone () const noexcept
wkf::ZonePoint *	GetZonePoint () const noexcept
wizard::Platform *	GetPlatform () const noexcept
wkf::PointOfInterest *	GetPointOfInterest () const noexcept
wizard::Editor *	GetEditor () const
const UtTextDocumentRange &	GetRange () const
WsfPProxyNode	GetProxyNode () const

Detailed Description

Wraps proxy object and visual objects to aid in making changes in the wizard::Editor triggered from the Map.

details

Due to the current read-only nature of the WsfPProxy, the Map triggers updates to the wizard::Editor directly. Developers should use this class wherever there are multiple changes occurring in the wizard::Editor to avoid corrupting the text when applying the changes. Adding this class to ordered containers, such as set and map, sort in reverse, as to mitigate the need to update other ChangeWrappers when applying the changes.

Postcondition

After construction, the mEditorPtr and mNode are initialized.

Constructor & Destructor Documentation

ChangeWrapper() [1/9]

wizard::ChangeWrapper::ChangeWrapper ( wizard::Editor * aEditorPtr, UtTextDocumentRange aRange )

inline

Referenced by operator<().

ChangeWrapper() [2/9]

wizard::ChangeWrapper::ChangeWrapper ( WsfPProxyNode aProxyNode )

explicit

Constructs a ChangeWrapper

Parameters

aProxyNode

is the proxy property to modify

ChangeWrapper() [3/9]

wizard::ChangeWrapper::ChangeWrapper	(	wizard::Platform *	aPlatformPtr,
		WsfPProxyNode	aProxyNode )

Constructs a ChangeWrapper

Parameters

aPlatformPtr	is the wizard::Platform modified on the Map
aProxyNode	is the proxy property to modify

ChangeWrapper() [4/9]

wizard::ChangeWrapper::ChangeWrapper ( wizard::Editor * aEditorPtr, vespa::VaAttachment * aAttachmentPtr, UtTextDocumentRange aRange )

inline

ChangeWrapper() [5/9]

wizard::ChangeWrapper::ChangeWrapper ( wizard::Editor * aEditorPtr, wizard::Platform * aPlatformPtr, vespa::VaAttachment * aAttachmentPtr, WsfPProxyNode aProxyNode )

inline

ChangeWrapper() [6/9]

wizard::ChangeWrapper::ChangeWrapper	(	wizard::Platform *	aPlatformPtr,
		vespa::VaAttachment *	aAttachmentPtr,
		WsfPProxyNode	aProxyNode )

Constructs a ChangeWrapper

Parameters

aPlatformPtr	is the wizard::Platform containing the attachment
aAttachmentPtr	is the vespa::VaAttachment modified on the Map
aProxyNode	is the proxy property to modify

ChangeWrapper() [7/9]

wizard::ChangeWrapper::ChangeWrapper	(	wizard::Platform *	aPlatformPtr,
		wkf::Waypoint *	aWaypointPtr,
		WsfPProxyNode	aProxyNode )

Constructs a ChangeWrapper

Parameters

aPlatformPtr	is the wizard::Platform containing the route
aWaypointPtr	is the wkf::Waypoint modified on the Map
aProxyNode	is the proxy property to modify

ChangeWrapper() [8/9]

wizard::ChangeWrapper::ChangeWrapper	(	wizard::Platform *	aPlatformPtr,
		wkf::ZonePoint *	aZonePointPtr,
		WsfPProxyNode	aProxyNode )

Constructs a ChangeWrapper

Parameters

aPlatformPtr	is the wizard::Platform containing the zone
aZonePointPtr	is the wkf::ZonePoint modified on the Map
aProxyNode	is the proxy property to modify

ChangeWrapper() [9/9]

wizard::ChangeWrapper::ChangeWrapper	(	wkf::PointOfInterest *	aPointOfInterestPtr,
		WsfPProxyNode	aProxyNode )

Parameters

aPointOfInterestPtr	is the wkf::PointOfInterest modified on the Map
aProxyNode	is the proxy property to modify

Member Function Documentation

GetEditor()

wizard::Editor * wizard::ChangeWrapper::GetEditor ( ) const

inline

References GetEditor().

Referenced by GetEditor().

GetPlatform()

wizard::Platform * wizard::ChangeWrapper::GetPlatform ( ) const

noexcept

Get the wizard::Platform that this ChangeWrapper wraps

Returns

the wizard::Platform that this ChangeWrapper wraps

GetPointOfInterest()

wkf::PointOfInterest * wizard::ChangeWrapper::GetPointOfInterest ( ) const

noexcept

Get the wkf::PointOfInterest that this ChangeWrapper wraps

Returns

the wkf::PointOfInterest that this ChangeWrapper wraps

GetProxyNode()

WsfPProxyNode wizard::ChangeWrapper::GetProxyNode ( ) const

inline

GetRange()

const UtTextDocumentRange & wizard::ChangeWrapper::GetRange ( ) const

inline

GetRoute()

wkf::AttachmentRoute * wizard::ChangeWrapper::GetRoute ( ) const

noexcept

Get the wkf::AttachmentRoute that this ChangeWrapper wraps

Returns

the wkf::AttachmentRoute that this ChangeWrapper wraps

GetWaypoint()

wkf::Waypoint * wizard::ChangeWrapper::GetWaypoint ( ) const

noexcept

Get the wkf::Waypoint that this ChangeWrapper wraps

Returns

the wkf::Waypoint that this ChangeWrapper wraps

GetZone()

wkf::AttachmentZone * wizard::ChangeWrapper::GetZone ( ) const

noexcept

Get the wkf::AttachmentZone that this ChangeWrapper wraps

Returns

the wkf::AttachmentZone that this ChangeWrapper wraps

GetZonePoint()

wkf::ZonePoint * wizard::ChangeWrapper::GetZonePoint ( ) const

noexcept

Get the wkf::ZonePoint that this ChangeWrapper wraps

Returns

the wkf::ZonePoint that this ChangeWrapper wraps

operator<()

bool wizard::ChangeWrapper::operator< ( const ChangeWrapper & aRHS ) const

inlinenoexcept

Allows sorting of ChangeWrapper in ordered containers.

Note

This sorts ChangeWrappers in descending order.

References ChangeWrapper().

---

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

• ChangeWrapper.hpp
• ChangeWrapper.cpp