Interface for components that provide a drawable overlay layer. More...

#include <Malena/Traits/Communication/OverlayWidget.h>

Public Types
enum class	Hook { REGISTER }

Public Member Functions
virtual	~OverlayWidget ()=default
virtual ml::Core &	getOverlay ()=0

Detailed Description

Interface for components that provide a drawable overlay layer.

Inherit OverlayWidget alongside Hookable and call sendHook(ml::OverlayWidget::Hook::REGISTER) to hand an overlay component to whatever shell is listening. The shell decides when and how to render it.

Usage

class MyOverlay : public ml::OverlayWidget, public ml::Hookable { ... };
 
// In shell registerHooks():
onHook(ml::OverlayWidget::Hook::REGISTER, [this](ml::OverlayWidget& w) {
    _activeOverlay = &w.getOverlay();
});

See also: SplitPaneWidget, ToolbarWidget

Definition at line 35 of file OverlayWidget.h.

Member Enumeration Documentation

◆ Hook

enum class ml::OverlayWidget::Hook

strong

Enumerator
REGISTER

Definition at line 37 of file OverlayWidget.h.

Constructor & Destructor Documentation

◆ ~OverlayWidget()

virtual ml::OverlayWidget::~OverlayWidget ( )

virtualdefault

Member Function Documentation

◆ getOverlay()

virtual ml::Core & ml::OverlayWidget::getOverlay ( )

pure virtual

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

Traits/Communication/OverlayWidget.h

Public Types

Public Member Functions