iview::IRuler Class Reference

Interface for ruler implementation. More...

#include <IRuler.h>

Inheritance diagram for iview::IRuler:

Collaboration diagram for iview::IRuler:

Public Types
typedef QPair< double, double >	Mark
Public Types inherited from istd::IChangeable
enum	ChangeFlags {   CF_ICF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING ,   CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...
enum	SupportedOperations {   SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 ,   SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 , SO_CHANGE_LOCK = 1 << 5 }
	Flags for supported operations. More...
enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...

Public Member Functions
virtual void	Reset ()=0
	Set levels count to 0 and remove all marks.
virtual void	Clear ()=0
	Remove all marks, but doesn't change reserved space.
virtual int	GetLevelsCount () const =0
	Get count of levels.
virtual void	SetLevelsCount (int count)=0
	Set levels count.
virtual i2d::CLine2d	GetScreenLine () const =0
	Get pixels range, that adequate mark value.
virtual void	ReserveLevelSpace (int levelIndex, int marksCount)=0
	Reserve marks space to optimize insert operation.
virtual int	GetMarksCount (int levelIndex) const =0
	Get count of marks on specified level.
virtual Mark	GetMark (int markIndex, int levelIndex) const =0
	Get a mark.
virtual void	InsertMark (int levelIndex, const Mark &mark)=0
	Insert new mark.
Public Member Functions inherited from istd::IChangeable
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.
virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
	Copy this object from another one.
virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.
virtual std::unique_ptr< IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
	Make a copy of this object.
virtual bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
	Reset data to its default state.
virtual QMutex *	GetChangesLock () const
	Get mutex beeing locked during changes, if available.
virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.
virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.
virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.
virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.

Additional Inherited Members
Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.
static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.
static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.
static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.
Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.
virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Detailed Description

Interface for ruler implementation.

Ruler allow to set a values at different positions on different levels. Level 0 is the most important.

Definition at line 28 of file IRuler.h.

Member Typedef Documentation

Mark

QPair<double, double> iview::IRuler::Mark

Definition at line 31 of file IRuler.h.

Member Function Documentation

Clear()

virtual void iview::IRuler::Clear ( )

pure virtual

Remove all marks, but doesn't change reserved space.

GetLevelsCount()

virtual int iview::IRuler::GetLevelsCount ( ) const

pure virtual

Get count of levels.

Higher levels have lower priority.

GetMark()

virtual Mark iview::IRuler::GetMark ( int markIndex, int levelIndex ) const

pure virtual

Get a mark.

First element of the mark is a relative position on ruler in range [0, 1]. Second element is the value.

GetMarksCount()

virtual int iview::IRuler::GetMarksCount ( int levelIndex ) const

pure virtual

Get count of marks on specified level.

GetScreenLine()

virtual i2d::CLine2d iview::IRuler::GetScreenLine ( ) const

pure virtual

Get pixels range, that adequate mark value.

InsertMark()

virtual void iview::IRuler::InsertMark ( int levelIndex, const Mark & mark )

pure virtual

Insert new mark.

See also

GetMark(int, int).

ReserveLevelSpace()

virtual void iview::IRuler::ReserveLevelSpace ( int levelIndex, int marksCount )

pure virtual

Reserve marks space to optimize insert operation.

Reset()

virtual void iview::IRuler::Reset ( )

pure virtual

Set levels count to 0 and remove all marks.

SetLevelsCount()

virtual void iview::IRuler::SetLevelsCount ( int count )

pure virtual

Set levels count.

All marks in the levels will be removed.

---

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

• iview/IRuler.h