LuciadCPillar 2023.1.04
luciad::FeatureEditCandidateEvent Class Referencefinal

This event provides information about the addition or removal of edit candidates. More...

#include <luciad/edit/features/IFeatureEditCandidateProvider.h>

Public Member Functions

 FeatureEditCandidateEvent ()
 Creates a new emtpy event. More...
 
 FeatureEditCandidateEvent (const FeatureEditCandidateEvent &other)
 
 FeatureEditCandidateEvent (FeatureEditCandidateEvent &&other) noexcept
 
 ~FeatureEditCandidateEvent ()
 
void editCandidateAdded (LayerFeatureId editCandidate)
 Adds information to the event that an edit candidate was added. More...
 
void editCandidateRemoved (LayerFeatureId editCandidate)
 Adds information to the event that an edit candidate was removed. More...
 
const std::vector< LayerFeatureId > & getAddedEditCandidates () const
 
const std::vector< LayerFeatureId > & getRemovedEditCandidates () const
 
FeatureEditCandidateEventoperator= (FeatureEditCandidateEvent other) noexcept
 

Detailed Description

This event provides information about the addition or removal of edit candidates.

See the related guide for an overview of the editing API.

See also
IFeatureEditCandidateObserver
IFeatureEditCandidateProvider
Since
2020.1

Constructor & Destructor Documentation

◆ FeatureEditCandidateEvent() [1/3]

luciad::FeatureEditCandidateEvent::FeatureEditCandidateEvent ( )

Creates a new emtpy event.

◆ ~FeatureEditCandidateEvent()

luciad::FeatureEditCandidateEvent::~FeatureEditCandidateEvent ( )

◆ FeatureEditCandidateEvent() [2/3]

luciad::FeatureEditCandidateEvent::FeatureEditCandidateEvent ( const FeatureEditCandidateEvent other)

◆ FeatureEditCandidateEvent() [3/3]

luciad::FeatureEditCandidateEvent::FeatureEditCandidateEvent ( FeatureEditCandidateEvent &&  other)
noexcept

Member Function Documentation

◆ editCandidateAdded()

void luciad::FeatureEditCandidateEvent::editCandidateAdded ( LayerFeatureId  editCandidate)

Adds information to the event that an edit candidate was added.

Parameters
editCandidatethe added edit candidate

◆ editCandidateRemoved()

void luciad::FeatureEditCandidateEvent::editCandidateRemoved ( LayerFeatureId  editCandidate)

Adds information to the event that an edit candidate was removed.

Parameters
editCandidatethe removed edit candidate

◆ getAddedEditCandidates()

const std::vector< LayerFeatureId > & luciad::FeatureEditCandidateEvent::getAddedEditCandidates ( ) const
Returns
all added edit candidates

◆ getRemovedEditCandidates()

const std::vector< LayerFeatureId > & luciad::FeatureEditCandidateEvent::getRemovedEditCandidates ( ) const
Returns
all removed edit candidates

◆ operator=()

FeatureEditCandidateEvent & luciad::FeatureEditCandidateEvent::operator= ( FeatureEditCandidateEvent  other)
noexcept