ACF $AcfVersion:0$
Public Types | Public Member Functions | Protected Types | Protected Member Functions | List of all members
iview::CLabelShape Class Reference

#include <CLabelShape.h>

Inheritance diagram for iview::CLabelShape:
iview::CPinShape iview::ITextLabelParams iview::CInteractiveShapeBase istd::IChangeable iview::CShapeBase iview::IInteractiveShape iview::IDraggable istd::IPolymorphic imod::CSingleModelObserverBase iview::IShape iview::IShape iview::IMouseActionObserver istd::IPolymorphic istd::IPolymorphic iview::ITouchable iview::IVisualizable imod::IObserver iview::ITouchable iview::IVisualizable imod::IObserver imod::IObserver

Public Types

typedef CPinShape BaseClass
 
typedef CInteractiveShapeBase ShapeBaseClass
 
- Public Types inherited from iview::CPinShape
typedef CInteractiveShapeBase BaseClass
 
- Public Types inherited from iview::CInteractiveShapeBase
typedef CShapeBase BaseClass
 
- Public Types inherited from iview::CShapeBase
enum  ShapeTransformMode { STM_VIEW , STM_SHAPE , STM_COMBINE }
 Describe how shape tranformation is interpreted. More...
 
typedef imod::CSingleModelObserverBase BaseClass
 
- Public Types inherited from imod::CSingleModelObserverBase
typedef imod::IModel ModelType
 
- Public Types inherited from iview::IShape
enum  ChangeFlags { CF_CALIB = 0x3663adf }
 Data model change notification flags. More...
 
- Public Types inherited from iview::ITouchable
enum  TouchState {
  TS_NONE , TS_INACTIVE , TS_TICKER , TS_DRAGGABLE ,
  TS_AREA , TS_OTHER , TS_LAST = TS_OTHER
}
 Enumeration for possible shape touch states. More...
 
- Public Types inherited from iview::ITextLabelParams
enum  TextAlign {
  TAL_CENTER , TAL_LEFT_TOP , TAL_RIGHT_TOP , TAL_LEFT_BOTTOM ,
  TAL_RIGHT_BOTTOM , TAL_AUTOMATIC , TAL_LAST = TAL_AUTOMATIC
}
 Text alignment mode. More...
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ACF_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
}
 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...
 
typedef QMultiMap< QByteArray, QVariant > ChangeInfoMap
 

Public Member Functions

 CLabelShape (TextAlign align=TAL_RIGHT_TOP, const istd::CIndex2d &offset=istd::CIndex2d(20, -20))
 
virtual bool IsPositionVisible () const
 
virtual void SetPositionVisible (bool visible=true)
 
virtual bool IsBackgroundTransparent () const
 
virtual void SetBackgroundTransparent (bool state=true)
 
virtual bool IsEditableOffset () const
 
virtual void SetEditableOffset (bool editable=true)
 
virtual TextAlign GetTextAlign () const override
 Get text alignment modein label shape.
 
virtual void SetTextAlign (TextAlign align) override
 Set text alignment mode.
 
virtual const istd::CIndex2dGetDrawOffset () const override
 Get the drawing offset for the label.
 
virtual void SetDrawOffset (const istd::CIndex2d &offset) override
 Set the drawing offset for the label.
 
virtual bool OnMouseButton (istd::CIndex2d position, Qt::MouseButton buttonType, bool downFlag) override
 It is called, when mouse button is pushed down or up on this object.
 
virtual bool OnMouseMove (istd::CIndex2d position) override
 It is called, when mouse is moved.
 
virtual void Draw (QPainter &drawContext) const override
 Draw this shape using draw context.
 
virtual bool OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
 Callback invoked when an observable model is about to be attached to this observer.
 
virtual TouchState IsTouched (istd::CIndex2d position) const override
 Check, if any shape is touched.
 
- Public Member Functions inherited from iview::CPinShape
 CPinShape ()
 
- Public Member Functions inherited from iview::CInteractiveShapeBase
 CInteractiveShapeBase ()
 
 CInteractiveShapeBase (const CInteractiveShapeBase &shape)
 
virtual ~CInteractiveShapeBase ()
 
virtual bool IsEditablePosition () const
 
virtual void SetEditablePosition (bool state=true)
 
virtual bool IsSelected () const override
 Check, if this shape is selected.
 
virtual void SetSelected (bool selectFlag=true) override
 Inform that this object was selected or deselected.
 
virtual bool IsDraggable () const override
 Check if drag is enabled.
 
virtual void BeginDrag (const istd::CIndex2d &position) override
 Called before dragging is begin.
 
virtual void SetDragPosition (const istd::CIndex2d &position) override
 Set new drag position.
 
virtual void EndDrag () override
 Called after dragging.
 
virtual bool OnModelDetached (imod::IModel *modelPtr) override
 Callback invoked when an observable model is about to be detached from this observer.
 
- Public Member Functions inherited from iview::CShapeBase
 CShapeBase ()
 
 CShapeBase (const CShapeBase &shape)
 
virtual ~CShapeBase ()
 
virtual bool AssignToLayer (int layerType)
 Assign this shape to same layer.
 
virtual void Invalidate ()
 
iview::IDisplayGetDisplayPtr () const
 Get access to currently connected display.
 
ShapeTransformMode GetTransformMode () const
 Get shape transformation mode.
 
void SetTransformMode (ShapeTransformMode mode)
 Set shape transformation mode.
 
i2d::CVector2d GetScreenPosition (const i2d::CVector2d &logPosition) const
 Get screen position based on logical position.
 
i2d::CVector2d GetLogPosition (const i2d::CVector2d &screenPosition) const
 Get logical position based on screen position.
 
virtual int GetLayerType () const override
 Get layer type of this shape object.
 
virtual i2d::CRect GetBoundingBox () const override
 Return bounding box in client window coordinates.
 
virtual void SetVisible (bool state=true) override
 Make shape to be visible or not.
 
virtual const IColorSchemaGetUserColorSchema () const override
 Get color schema from view or user defined.
 
virtual void SetUserColorSchema (const IColorSchema *schemaPtr) override
 Set color schema to draw shape.
 
virtual void SetDefaultDescription (const QString &description) override
 Set default description will be used to display on console.
 
virtual void SetToolTip (const QString &toolTip) override
 
virtual bool IsInside (const istd::CIndex2d &screenPosition) const override
 
virtual bool IsVisible () const override
 Check, if this object is visible.
 
virtual bool IsDisplayAccepted (const IDisplay &display) const override
 Check if this object can be connected to this display.
 
virtual void OnConnectDisplay (IDisplay *displayPtr) override
 Called after display is connected.
 
virtual void OnDisconnectDisplay (IDisplay *displayPtr) override
 Called after display is disconnected.
 
virtual bool OnDisplayChange (const istd::IChangeable::ChangeSet &changeSet) override
 It informs about changes in display.
 
virtual QString GetShapeDescriptionAt (istd::CIndex2d position) const override
 Get description to shape at specified position.
 
virtual QString GetToolTipAt (istd::CIndex2d position) const override
 Get tooltip at specified position.
 
virtual void OnUpdate (const istd::IChangeable::ChangeSet &changeSet) override
 Called on update of observed model.
 
- Public Member Functions inherited from imod::CSingleModelObserverBase
 CSingleModelObserverBase ()
 
virtual ~CSingleModelObserverBase ()
 
imod::IModelGetObservedModel () const
 Get access to observed model.
 
imod::IModelGetModelPtr () const
 Get access to observed model.
 
void EnsureModelDetached ()
 Make sure this observer is detached.
 
void SetObservedIds (const istd::IChangeable::ChangeSet &changeMask)
 Set list of ID's beeing observed.
 
virtual bool IsModelAttached (const imod::IModel *modelPtr=NULL) const override
 Checks if the specified model is currently attached to this observer.
 
virtual void BeforeUpdate (imod::IModel *modelPtr) override
 Callback invoked before an update of the observer's content occurs.
 
virtual void AfterUpdate (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet) override
 Callback invoked after an update of the observer's content occurs.
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- Public Member Functions inherited from iview::IShape
virtual bool IsAreaTouchAllowed () const
 
virtual void SetAreaTouchAllowed (bool=true)
 
virtual iview::ISelectable::MousePointerMode UpdateMousePointer (iview::ISelectable::MousePointerMode defaultPointer, ITouchable::TouchState, const istd::CIndex2d &) const
 
- 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 istd::TUniqueInterfacePtr< istd::IChangeableCloneMe (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 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.
 

Protected Types

enum  EditMode { EM_NONE , EM_POSITION , EM_OFFSET }
 

Protected Member Functions

void CalculateTextOriginSize (i2d::CRect &textBox) const
 
virtual i2d::CRect CalcBoundingBox () const override
 Calculate bounding box.
 
- Protected Member Functions inherited from iview::CPinShape
virtual void BeginLogDrag (const i2d::CVector2d &reference) override
 
virtual void SetLogDragPosition (const i2d::CVector2d &position) override
 
- Protected Member Functions inherited from iview::CInteractiveShapeBase
void BeginTickerDrag ()
 
void EndTickerDrag ()
 
void UpdateModelChanges ()
 
int GetKeysState () const
 Get actual keys state.
 
int GetEditMode () const
 Get actual edit mode.
 
int GetDisplayMode () const
 Get actual display mode.
 
void DrawText (QPainter &drawContext, istd::CIndex2d point, const QString &text) const
 Draw text on a given position.
 
virtual bool IsDisplayChangeImportant (const istd::IChangeable::ChangeSet &changeSet) override
 Get display changes mask.
 
- Protected Member Functions inherited from iview::CShapeBase
double GetLocalLineWidth (const i2d::CVector2d &screenPosition) const
 Get line with (in logical coordinates) for single screen position.
 
virtual void InvalidateBoundingBox ()
 Invalidate bounding box.
 
bool IsDisplayConnected () const
 Check if display is connected.
 
const IColorSchemaGetColorSchema () const
 Get color schema for this shape.
 
i2d::CRect GetClientRect () const
 Get display client rectangle.
 
bool IsBoundingBoxValid () const
 
void DisconnectDisplay ()
 
virtual const iview::CScreenTransformGetViewToScreenTransform () const
 
- Protected Member Functions inherited from imod::CSingleModelObserverBase
void SetModelPtr (imod::IModel *modelPtr)
 Set internal model pointer to specified value.
 
- 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.
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set.
 
- Protected Attributes inherited from iview::CPinShape
i2d::CVector2d m_referencePosition
 
- Static Protected Attributes inherited from imod::CSingleModelObserverBase
static const istd::IChangeable::ChangeSet s_undoChanges
 

Detailed Description

Definition at line 14 of file CLabelShape.h.

Member Typedef Documentation

◆ BaseClass

Definition at line 17 of file CLabelShape.h.

◆ ShapeBaseClass

Definition at line 18 of file CLabelShape.h.

Member Enumeration Documentation

◆ EditMode

Enumerator
EM_NONE 
EM_POSITION 
EM_OFFSET 

Definition at line 51 of file CLabelShape.h.

Constructor & Destructor Documentation

◆ CLabelShape()

iview::CLabelShape::CLabelShape ( TextAlign  align = TAL_RIGHT_TOP,
const istd::CIndex2d offset = istd::CIndex2d(20, -20) 
)

Member Function Documentation

◆ CalcBoundingBox()

virtual i2d::CRect iview::CLabelShape::CalcBoundingBox ( ) const
overrideprotectedvirtual

Calculate bounding box.

You have to implement this method in your shapes implementations.

Reimplemented from iview::CPinShape.

◆ CalculateTextOriginSize()

void iview::CLabelShape::CalculateTextOriginSize ( i2d::CRect textBox) const
protected

◆ Draw()

virtual void iview::CLabelShape::Draw ( QPainter &  drawContext) const
overridevirtual

Draw this shape using draw context.

Reimplemented from iview::CPinShape.

◆ GetDrawOffset()

const istd::CIndex2d & iview::CLabelShape::GetDrawOffset ( ) const
inlineoverridevirtual

Get the drawing offset for the label.

Implements iview::ITextLabelParams.

Definition at line 126 of file CLabelShape.h.

◆ GetTextAlign()

CLabelShape::TextAlign iview::CLabelShape::GetTextAlign ( ) const
inlineoverridevirtual

Get text alignment modein label shape.

Implements iview::ITextLabelParams.

Definition at line 114 of file CLabelShape.h.

◆ IsBackgroundTransparent()

bool iview::CLabelShape::IsBackgroundTransparent ( ) const
inlinevirtual

Definition at line 88 of file CLabelShape.h.

◆ IsEditableOffset()

bool iview::CLabelShape::IsEditableOffset ( ) const
inlinevirtual

Definition at line 100 of file CLabelShape.h.

◆ IsPositionVisible()

bool iview::CLabelShape::IsPositionVisible ( ) const
inlinevirtual

Definition at line 76 of file CLabelShape.h.

◆ IsTouched()

virtual TouchState iview::CLabelShape::IsTouched ( istd::CIndex2d  position) const
overridevirtual

Check, if any shape is touched.

When shape is touched, it return also pointer to this shape.

Returns
touch state for the shape, or iview::IInteractiveShape::TS_NONE, when nothing found.

Reimplemented from iview::CPinShape.

◆ OnModelAttached()

virtual bool iview::CLabelShape::OnModelAttached ( imod::IModel modelPtr,
istd::IChangeable::ChangeSet changeMask 
)
overridevirtual

Callback invoked when an observable model is about to be attached to this observer.

This method is called by the model when attempting to establish an observer relationship. The implementation should:

  1. Validate that the model is of an acceptable type
  2. Set the changeMask to specify which changes to monitor
  3. Return true to accept the attachment, or false to reject it
Parameters
modelPtrPointer to the model object being attached. Never nullptr.
changeMaskOutput parameter where the observer specifies which change types it wants to be notified about. Set the appropriate change flags using changeMask.Set(changeId). An empty mask means the observer wants all changes.
Returns
true if the model is accepted and attachment succeeds, false to reject the attachment (e.g., if the model is of incompatible type).
Note
After successful attachment, the observer should initialize its state based on the current model data.
The changeMask allows filtering notifications for better performance. Only changes matching the mask will trigger AfterUpdate() calls.
virtual bool OnModelAttached(IModel* modelPtr,
{
// Type check
CMyModel* model = dynamic_cast<CMyModel*>(modelPtr);
if (!model) return false;
// Set up change filtering
changeMask.Set(CMyModel::CF_DATA_CHANGED);
changeMask.Set(CMyModel::CF_STATUS_CHANGED);
// Don't set CF_INTERNAL_CHANGED - we don't care about those
// Initialize view from current model state
UpdateViewFromModel(model);
return true;
}
Set of change flags (its IDs).
Definition IChangeable.h:36
virtual bool OnModelAttached(imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
Callback invoked when an observable model is about to be attached to this observer.
See also
OnModelDetached(), IsModelAttached(), AfterUpdate()

Reimplemented from iview::CPinShape.

◆ OnMouseButton()

virtual bool iview::CLabelShape::OnMouseButton ( istd::CIndex2d  position,
Qt::MouseButton  buttonType,
bool  downFlag 
)
overridevirtual

It is called, when mouse button is pushed down or up on this object.

Parameters
position- position of mouse pointer on client area (picture coords).
downFlag- true, if mouse button is pushed down, false if pushed up.
Returns
true if this shape should get focus to catch all mouse movements.

Reimplemented from iview::CPinShape.

◆ OnMouseMove()

virtual bool iview::CLabelShape::OnMouseMove ( istd::CIndex2d  position)
overridevirtual

It is called, when mouse is moved.

Only objects with focus receive this event.

Parameters
position- position of mouse pointer on client area (picture coords).
Returns
true if this shape should hold focus to catch longer all mouse movements.

Reimplemented from iview::CPinShape.

◆ SetBackgroundTransparent()

void iview::CLabelShape::SetBackgroundTransparent ( bool  state = true)
inlinevirtual

Definition at line 94 of file CLabelShape.h.

◆ SetDrawOffset()

void iview::CLabelShape::SetDrawOffset ( const istd::CIndex2d offset)
inlineoverridevirtual

Set the drawing offset for the label.

Implements iview::ITextLabelParams.

Definition at line 132 of file CLabelShape.h.

◆ SetEditableOffset()

void iview::CLabelShape::SetEditableOffset ( bool  editable = true)
inlinevirtual

Definition at line 106 of file CLabelShape.h.

◆ SetPositionVisible()

void iview::CLabelShape::SetPositionVisible ( bool  visible = true)
inlinevirtual

Definition at line 82 of file CLabelShape.h.

◆ SetTextAlign()

void iview::CLabelShape::SetTextAlign ( TextAlign  align)
inlineoverridevirtual

Set text alignment mode.

Implements iview::ITextLabelParams.

Definition at line 120 of file CLabelShape.h.


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