LibreOffice Module sd (master) 1
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
sd::SmartTag Class Reference

a smart tag represents a visual user interface element on the documents edit view that is not part of the document. More...

#include <smarttag.hxx>

Inheritance diagram for sd::SmartTag:
[legend]
Collaboration diagram for sd::SmartTag:
[legend]

Public Member Functions

 SmartTag (::sd::View &rView)
 
virtual ~SmartTag () override
 
virtual bool MouseButtonDown (const MouseEvent &, SmartHdl &)
 returns true if the SmartTag consumes this event. More...
 
virtual bool KeyInput (const KeyEvent &rKEvt)
 returns true if the SmartTag consumes this event. More...
 
virtual bool Command (const CommandEvent &rCEvt)
 returns true if the SmartTag consumes this event. More...
 
bool isSelected () const
 returns true if this smart tag is currently selected More...
 
::sd::ViewgetView () const
 
- Public Member Functions inherited from sd::SimpleReferenceComponent
 SimpleReferenceComponent ()
 
void acquire ()
 @ATTENTION The results are undefined if, for any individual instance of SimpleReferenceComponent, the total number of calls to acquire() exceeds the total number of calls to release() by a platform dependent amount (which, hopefully, is quite large). More...
 
void release ()
 
void Dispose ()
 
bool isDisposed () const
 

Protected Member Functions

virtual sal_Int32 GetMarkablePointCount () const
 
virtual sal_Int32 GetMarkedPointCount () const
 
virtual bool MarkPoint (SdrHdl &rHdl, bool bUnmark)
 
virtual void CheckPossibilities ()
 
virtual bool MarkPoints (const ::tools::Rectangle *pRect, bool bUnmark)
 
virtual void addCustomHandles (SdrHdlList &rHandlerList)
 
virtual void select ()
 
virtual void deselect ()
 
virtual bool getContext (SdrViewContext &rContext)
 
virtual void disposing () override
 
- Protected Member Functions inherited from sd::SimpleReferenceComponent
virtual void disposing ()
 
virtual ~SimpleReferenceComponent ()
 

Protected Attributes

::sd::ViewmrView
 
bool mbSelected
 

Private Member Functions

 SmartTag (const SmartTag &)=delete
 
SmartTagoperator= (const SmartTag &)=delete
 

Friends

class SmartTagSet
 

Detailed Description

a smart tag represents a visual user interface element on the documents edit view that is not part of the document.

It uses derivations from SmartHdl for its visuals. A SmartTag adds himself to the given view if created. It removes himself if it is disposed before the view is disposed.

Derive from this class to implement your own smart tag.

Definition at line 43 of file smarttag.hxx.

Constructor & Destructor Documentation

◆ SmartTag() [1/2]

sd::SmartTag::SmartTag ( ::sd::View rView)
explicit

Definition at line 31 of file smarttag.cxx.

References sd::SmartTagSet::add(), sd::View::getSmartTags(), and mrView.

◆ ~SmartTag()

sd::SmartTag::~SmartTag ( )
overridevirtual

Definition at line 39 of file smarttag.cxx.

◆ SmartTag() [2/2]

sd::SmartTag::SmartTag ( const SmartTag )
privatedelete

Member Function Documentation

◆ addCustomHandles()

void sd::SmartTag::addCustomHandles ( SdrHdlList rHandlerList)
protectedvirtual

Reimplemented in sd::MotionPathTag, and sd::AnnotationTag.

Definition at line 60 of file smarttag.cxx.

◆ CheckPossibilities()

void sd::SmartTag::CheckPossibilities ( )
protectedvirtual

Reimplemented in sd::MotionPathTag, and sd::AnnotationTag.

Definition at line 105 of file smarttag.cxx.

◆ Command()

bool sd::SmartTag::Command ( const CommandEvent rCEvt)
virtual

returns true if the SmartTag consumes this event.

Reimplemented in sd::AnnotationTag.

Definition at line 55 of file smarttag.cxx.

◆ deselect()

void sd::SmartTag::deselect ( )
protectedvirtual

Reimplemented in sd::MotionPathTag, and sd::AnnotationTag.

Definition at line 69 of file smarttag.cxx.

References mbSelected.

Referenced by sd::MotionPathTag::deselect(), and sd::AnnotationTag::deselect().

◆ disposing()

void sd::SmartTag::disposing ( )
overrideprotectedvirtual

◆ getContext()

bool sd::SmartTag::getContext ( SdrViewContext rContext)
protectedvirtual

Reimplemented in sd::MotionPathTag, and sd::AnnotationTag.

Definition at line 80 of file smarttag.cxx.

◆ GetMarkablePointCount()

sal_Int32 sd::SmartTag::GetMarkablePointCount ( ) const
protectedvirtual

Reimplemented in sd::MotionPathTag, and sd::AnnotationTag.

Definition at line 85 of file smarttag.cxx.

◆ GetMarkedPointCount()

sal_Int32 sd::SmartTag::GetMarkedPointCount ( ) const
protectedvirtual

Reimplemented in sd::MotionPathTag, and sd::AnnotationTag.

Definition at line 90 of file smarttag.cxx.

◆ getView()

::sd::View & sd::SmartTag::getView ( ) const
inline

Definition at line 63 of file smarttag.hxx.

References mrView.

Referenced by sd::AnnotationTag::OpenPopup().

◆ isSelected()

bool sd::SmartTag::isSelected ( ) const
inline

◆ KeyInput()

bool sd::SmartTag::KeyInput ( const KeyEvent rKEvt)
virtual

returns true if the SmartTag consumes this event.

Reimplemented in sd::MotionPathTag, and sd::AnnotationTag.

Definition at line 49 of file smarttag.cxx.

◆ MarkPoint()

bool sd::SmartTag::MarkPoint ( SdrHdl rHdl,
bool  bUnmark 
)
protectedvirtual

Reimplemented in sd::MotionPathTag, and sd::AnnotationTag.

Definition at line 95 of file smarttag.cxx.

◆ MarkPoints()

bool sd::SmartTag::MarkPoints ( const ::tools::Rectangle pRect,
bool  bUnmark 
)
protectedvirtual

Reimplemented in sd::MotionPathTag, and sd::AnnotationTag.

Definition at line 100 of file smarttag.cxx.

◆ MouseButtonDown()

bool sd::SmartTag::MouseButtonDown ( const MouseEvent ,
SmartHdl  
)
virtual

returns true if the SmartTag consumes this event.

Reimplemented in sd::MotionPathTag, and sd::AnnotationTag.

Definition at line 43 of file smarttag.cxx.

◆ operator=()

SmartTag & sd::SmartTag::operator= ( const SmartTag )
privatedelete

◆ select()

void sd::SmartTag::select ( )
protectedvirtual

Reimplemented in sd::AnnotationTag.

Definition at line 64 of file smarttag.cxx.

References mbSelected.

Referenced by sd::AnnotationTag::select().

Friends And Related Function Documentation

◆ SmartTagSet

friend class SmartTagSet
friend

Definition at line 45 of file smarttag.hxx.

Member Data Documentation

◆ mbSelected

bool sd::SmartTag::mbSelected
protected

Definition at line 80 of file smarttag.hxx.

Referenced by deselect(), isSelected(), and select().

◆ mrView

::sd::View& sd::SmartTag::mrView
protected

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