Mapper  0.9.0
API documentation
Public Slots | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OpenOrienteering::SwitchSymbolUndoStep Class Reference

Map undo step which changes the symbols of referenced objects. More...

#include <object_undo.h>

Inheritance diagram for OpenOrienteering::SwitchSymbolUndoStep:
Inheritance graph
[legend]
Collaboration diagram for OpenOrienteering::SwitchSymbolUndoStep:
Collaboration graph
[legend]

Public Slots

virtual void symbolChanged (int pos, const OpenOrienteering::Symbol *new_symbol, const OpenOrienteering::Symbol *old_symbol)
 
virtual void symbolDeleted (int pos, const OpenOrienteering::Symbol *old_symbol)
 

Public Member Functions

 SwitchSymbolUndoStep (Map *map)
 
 ~SwitchSymbolUndoStep () override
 
bool isValid () const override
 Returns true if the step can still be undone. More...
 
virtual void addObject (int index, const Symbol *target_symbol)
 
UndoStepundo () override
 Undoes the action and returns a new UndoStep. More...
 
- Public Member Functions inherited from QObject
virtual const QMetaObjectmetaObject () const const
 
 QObject (QObject *parent)
 
virtual ~QObject ()
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
QString objectName () const const
 
void setObjectName (const QString &name)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
bool signalsBlocked () const const
 
bool blockSignals (bool block)
 
QThreadthread () const const
 
void moveToThread (QThread *targetThread)
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
void killTimer (int id)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
const QObjectListchildren () const const
 
void setParent (QObject *parent)
 
void installEventFilter (QObject *filterObj)
 
void removeEventFilter (QObject *obj)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectTree ()
 
void dumpObjectInfo ()
 
void dumpObjectTree () const const
 
void dumpObjectInfo () const const
 
bool setProperty (const char *name, const QVariant &value)
 
QVariant property (const char *name) const const
 
QList< QByteArraydynamicPropertyNames () const const
 
void destroyed (QObject *obj)
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
bool inherits (const char *className) const const
 
void deleteLater ()
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
 Q_CLASSINFO (Name, Value)
 
 Q_INTERFACES (...)
 
 Q_PROPERTY (...)
 
 Q_ENUMS (...)
 
 Q_FLAGS (...)
 
 Q_ENUM (...)
 
 Q_FLAG (...)
 
 Q_ENUM_NS (...)
 
 Q_FLAG_NS (...)
 
 Q_OBJECT Q_OBJECT
 
 Q_GADGET Q_GADGET
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SLOTS Q_SLOTS
 
 Q_SLOT Q_SLOT
 
 Q_EMIT Q_EMIT
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
- Public Member Functions inherited from OpenOrienteering::ObjectModifyingUndoStep
 ObjectModifyingUndoStep (Type type, Map *map)
 Creates an ObjectModifyingUndoStep for the given map and its current part. More...
 
 ObjectModifyingUndoStep (Type type, Map *map, int part_index)
 Creates an ObjectModifyingUndoStep for the given map and part. More...
 
 ~ObjectModifyingUndoStep () override
 Destructor. More...
 
int getPartIndex () const
 Returns the index of the map part modified by this undo step. More...
 
void setPartIndex (int part_index)
 Set the index of the map part modified by this undo step. More...
 
virtual bool isEmpty () const
 Returns true if no objects are modified by this undo step. More...
 
virtual void addObject (int index)
 Adds an object (by index) to this step. More...
 
bool getModifiedParts (PartSet &out) const override
 Adds the the step's modified part to the container provided by out. More...
 
void getModifiedObjects (int part_index, ObjectSet &out) const override
 Adds the list of the step's modified objects to the container provided by out. More...
 
- Public Member Functions inherited from OpenOrienteering::UndoStep
 UndoStep (Type type, Map *map)
 Constructs an undo step having the given type. More...
 
 UndoStep (const UndoStep &)=delete
 
 UndoStep (UndoStep &&)=delete
 
virtual ~UndoStep ()
 Destructor. More...
 
UndoStepoperator= (const UndoStep &)=delete
 
UndoStepoperator= (UndoStep &&)=delete
 
Type getType () const
 Returns the type of the undo step. More...
 
void save (QXmlStreamWriter &xml) const
 Saves the undo step to the stream in xml format. More...
 

Protected Member Functions

void saveImpl (QXmlStreamWriter &xml) const override
 Saves undo properties to the the xml stream. More...
 
void loadImpl (QXmlStreamReader &xml, SymbolDictionary &symbol_dict) override
 Loads undo properties from the the xml stream. More...
 
- Protected Member Functions inherited from QObject
QObjectsender () const const
 
int senderSignalIndex () const const
 
int receivers (const char *signal) const const
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
virtual void timerEvent (QTimerEvent *event)
 
virtual void childEvent (QChildEvent *event)
 
virtual void customEvent (QEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
- Protected Member Functions inherited from OpenOrienteering::ObjectModifyingUndoStep
virtual void saveObject (XmlElementWriter &xml, int index) const
 Saves object details to the the xml stream. More...
 
virtual void loadObject (XmlElementReader &xml, int index)
 Loads object details from the the xml stream. More...
 

Protected Attributes

std::vector< const Symbol * > target_symbols
 
bool valid
 
- Protected Attributes inherited from OpenOrienteering::ObjectModifyingUndoStep
ObjectList modified_objects
 Indices of the existing objects that are modified by this step. More...
 
- Protected Attributes inherited from OpenOrienteering::UndoStep
Type const type
 The type of the undo step. More...
 
Map *const map
 The map this undo step belongs. More...
 

Additional Inherited Members

- Public Types inherited from OpenOrienteering::UndoStep
enum  Type {
  ReplaceObjectsUndoStepType = 0, DeleteObjectsUndoStepType = 1, AddObjectsUndoStepType = 2, SwitchSymbolUndoStepType = 3,
  SwitchDashesUndoStepType = 4, CombinedUndoStepType = 5, ValidNoOpUndoStepType = 6, ObjectTagsUndoStepType = 7,
  MapPartUndoStepType = 8, SwitchPartUndoStepTypeV0 = 9, SwitchPartUndoStepType = 10, InvalidUndoStepType = 999
}
 Types of undo steps for identification. More...
 
typedef std::set< int > PartSet
 A set of integers referring to parts. More...
 
typedef std::set< Object * > ObjectSet
 A set of pointers to objects. More...
 
- Static Public Member Functions inherited from QObject
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
- Static Public Member Functions inherited from OpenOrienteering::UndoStep
static UndoStepgetUndoStepForType (Type type, Map *map)
 Constructs an undo step of the given type. More...
 
static UndoStepload (QXmlStreamReader &xml, Map *map, SymbolDictionary &symbol_dict)
 Loads the undo step from the stream in xml format. More...
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Types inherited from OpenOrienteering::ObjectModifyingUndoStep
typedef std::vector< int > ObjectList
 A list of indices referring to objects in a map part. More...
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Map undo step which changes the symbols of referenced objects.

Constructor & Destructor Documentation

◆ SwitchSymbolUndoStep()

OpenOrienteering::SwitchSymbolUndoStep::SwitchSymbolUndoStep ( Map map)

◆ ~SwitchSymbolUndoStep()

OpenOrienteering::SwitchSymbolUndoStep::~SwitchSymbolUndoStep ( )
override

Member Function Documentation

◆ addObject()

void OpenOrienteering::SwitchSymbolUndoStep::addObject ( int  index,
const Symbol target_symbol 
)
virtual

◆ isValid()

bool OpenOrienteering::SwitchSymbolUndoStep::isValid ( ) const
overridevirtual

Returns true if the step can still be undone.

Initially (after generating the step) this must return true. (However, this is different for InvalidUndoStep.)

Derived classes may return false to indicate that the step is no longer valid. This may happen after an object the step depends on, which is not tracked by the undo system, is deleted.

Example: changing a map object's symbol to a different one, then deleting the first symbol. Then changing the symbol cannot be undone as the old symbol does not exist anymore.

Reimplemented from OpenOrienteering::UndoStep.

◆ loadImpl()

void OpenOrienteering::SwitchSymbolUndoStep::loadImpl ( QXmlStreamReader xml,
SymbolDictionary symbol_dict 
)
overrideprotectedvirtual

Loads undo properties from the the xml stream.

Implementations in derived classes shall first check the element's name for one of their own elements, and otherwise call the parent class' implementation.

Reimplemented from OpenOrienteering::ObjectModifyingUndoStep.

◆ saveImpl()

void OpenOrienteering::SwitchSymbolUndoStep::saveImpl ( QXmlStreamWriter xml) const
overrideprotectedvirtual

Saves undo properties to the the xml stream.

Implementations in derived classes shall first call the parent class' implementation, and then start a new element for additional properties.

Reimplemented from OpenOrienteering::ObjectModifyingUndoStep.

◆ symbolChanged

void OpenOrienteering::SwitchSymbolUndoStep::symbolChanged ( int  pos,
const OpenOrienteering::Symbol new_symbol,
const OpenOrienteering::Symbol old_symbol 
)
virtualslot

◆ symbolDeleted

void OpenOrienteering::SwitchSymbolUndoStep::symbolDeleted ( int  pos,
const OpenOrienteering::Symbol old_symbol 
)
virtualslot

◆ undo()

UndoStep * OpenOrienteering::SwitchSymbolUndoStep::undo ( )
overridevirtual

Undoes the action and returns a new UndoStep.

The returned UndoStep can redo the action again.

Implements OpenOrienteering::UndoStep.

Member Data Documentation

◆ target_symbols

std::vector<const Symbol*> OpenOrienteering::SwitchSymbolUndoStep::target_symbols
protected

◆ valid

bool OpenOrienteering::SwitchSymbolUndoStep::valid
protected

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