Inviwo  0.9.10.1
Inviwo documentation
Public Types | Public Member Functions | Protected Attributes | List of all members
inviwo::InteractionEvent Class Referenceabstract
+ Inheritance diagram for inviwo::InteractionEvent:

Public Types

using ToolTipCallback = std::function< void(const std::string &)>
 

Public Member Functions

 InteractionEvent (KeyModifiers modifiers=KeyModifiers(flags::empty))
 
 InteractionEvent (const InteractionEvent &rhs)=default
 
InteractionEvent & operator= (const InteractionEvent &that)=default
 
virtual InteractionEvent * clone () const override=0
 
KeyModifiers modifiers () const
 
void setModifiers (KeyModifiers modifiers)
 
std::string modifierNames () const
 
void setToolTip (const std::string &tooltip) const
 
void setToolTipCallback (ToolTipCallback callback)
 
const ToolTipCallback & getToolTipCallback () const
 
- Public Member Functions inherited from inviwo::Event
virtual uint64_t hash () const =0
 
virtual bool shouldPropagateTo (Inport *inport, Processor *processor, Outport *source)
 
void markAsUsed ()
 
bool hasBeenUsed () const
 
void markAsUnused ()
 
void markAsVisited (Processor *)
 
void markAsVisited (Event &)
 
bool hasVisitedProcessor (Processor *) const
 
const std::vector< Processor * > & getVisitedProcessors () const
 
template<typename EventType >
EventType * getAs ()
 
template<typename EventType >
const EventType * getAs () const
 
virtual void print (std::ostream &ss) const
 

Protected Attributes

KeyModifiers modifiers_
 
ToolTipCallback tooltip_
 

Additional Inherited Members

- Protected Member Functions inherited from inviwo::Event
 Event (const Event &rhs)=default
 
Event & operator= (const Event &that)=default
 

Member Function Documentation

◆ setToolTip()

void inviwo::InteractionEvent::setToolTip ( const std::string &  tooltip) const

Display a tool tip using the optionally set tool tip callback. If no tool tip callback is set, the function does nothing. The supported formation depends on the used back end, but simple html is usually supported. Calling the function with an empty sting will hide any existing tool tip.

◆ setToolTipCallback()

void inviwo::InteractionEvent::setToolTipCallback ( ToolTipCallback  callback)

Set a tool tip call back function. The function should display a tool tip with the given string at the position if of the event. This function is usually called by the originating event canvas, and not any regular user code.

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