openswmmvis::ui::LegendOverlay Class Reference

#include <legendoverlay.h>

Inheritance diagram for openswmmvis::ui::LegendOverlay:

Collaboration diagram for openswmmvis::ui::LegendOverlay:

Signals
void	hideRequested ()
	Emitted when the user selects "Hide Legend" from the context menu. The toolbar should toggle actionShowLegend off to match; the overlay itself only calls hide().

Public Member Functions
	LegendOverlay (MapCanvas *canvas)
	~LegendOverlay () override
void	setCanvas (MapCanvas *canvas)
	Re-bind to a (possibly null) canvas; disconnects from the old canvas's signals and connects to the new one's.
OpenSWMM::Render::LegendOverlayStyle *	style () const noexcept
	Returns the LegendOverlayStyle this overlay paints with. Never null while the overlay exists. Caller should not delete the returned object.
void	setStyle (OpenSWMM::Render::LegendOverlayStyle *style, bool takeOwnership=false)
	Swap in a different (project- or canvas-scoped) style. The overlay disconnects from the previous style's signals and takes ownership of style only if takeOwnership is true.

Protected Member Functions
void	paintEvent (QPaintEvent *event) override
void	mousePressEvent (QMouseEvent *event) override
void	mouseMoveEvent (QMouseEvent *event) override
void	mouseReleaseEvent (QMouseEvent *event) override
void	contextMenuEvent (QContextMenuEvent *event) override
bool	eventFilter (QObject *watched, QEvent *event) override

Constructor & Destructor Documentation

LegendOverlay()

openswmmvis::ui::LegendOverlay::LegendOverlay ( MapCanvas *  canvas )

explicit

Here is the call graph for this function:

~LegendOverlay()

openswmmvis::ui::LegendOverlay::~LegendOverlay ( )

override

Member Function Documentation

contextMenuEvent()

void openswmmvis::ui::LegendOverlay::contextMenuEvent ( QContextMenuEvent *  event )

overrideprotected

Here is the call graph for this function:

eventFilter()

bool openswmmvis::ui::LegendOverlay::eventFilter ( QObject *  watched, QEvent *  event  )

overrideprotected

hideRequested

void openswmmvis::ui::LegendOverlay::hideRequested ( )

signal

Emitted when the user selects "Hide Legend" from the context menu. The toolbar should toggle actionShowLegend off to match; the overlay itself only calls hide().

Here is the caller graph for this function:

mouseMoveEvent()

void openswmmvis::ui::LegendOverlay::mouseMoveEvent ( QMouseEvent *  event )

overrideprotected

Here is the call graph for this function:

mousePressEvent()

void openswmmvis::ui::LegendOverlay::mousePressEvent ( QMouseEvent *  event )

overrideprotected

mouseReleaseEvent()

void openswmmvis::ui::LegendOverlay::mouseReleaseEvent ( QMouseEvent *  event )

overrideprotected

Here is the call graph for this function:

paintEvent()

void openswmmvis::ui::LegendOverlay::paintEvent ( QPaintEvent *  event )

overrideprotected

Here is the call graph for this function:

setCanvas()

void openswmmvis::ui::LegendOverlay::setCanvas

(

MapCanvas *

canvas

)

Re-bind to a (possibly null) canvas; disconnects from the old canvas's signals and connects to the new one's.

Here is the call graph for this function:

Here is the caller graph for this function:

setStyle()

void openswmmvis::ui::LegendOverlay::setStyle	(	OpenSWMM::Render::LegendOverlayStyle *	style,
		bool	takeOwnership = false
	)

Swap in a different (project- or canvas-scoped) style. The overlay disconnects from the previous style's signals and takes ownership of style only if takeOwnership is true.

Here is the call graph for this function:

style()

OpenSWMM::Render::LegendOverlayStyle * openswmmvis::ui::LegendOverlay::style ( ) const

inlinenoexcept

Returns the LegendOverlayStyle this overlay paints with. Never null while the overlay exists. Caller should not delete the returned object.

Here is the caller graph for this function:

---

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

• /home/runner/work/openswmm.gui/openswmm.gui/include/ui/widgets/legendoverlay.h
• /home/runner/work/openswmm.gui/openswmm.gui/src/ui/widgets/legendoverlay.cpp