Magnum::Ui::Panel class new in Git master
#include <Magnum/Ui/Panel.h>

Panel widget.

Base classes

template<class UserInterface>
class BasicWidget<UserInterface> new in Git master
Templated abstract base for stateful widgets.

Constructors, destructors, conversion operators

Panel(Anchor anchor, PanelStyle style = PanelStyle::Default) explicit
Constructor.
Panel(NonOwnedT, Anchor anchor, PanelStyle style = PanelStyle::Default) explicit
Construct a non-owned panel.
Panel(NoCreateT) explicit
Construct with no underlying node.

Public functions

auto style() const -> PanelStyle
Style.
auto setStyle(PanelStyle style) -> Panel&
Set style.
auto setStyle(PanelStyle style, Nanoseconds time) -> Panel&
Set style at given time.
auto contents() const -> Anchor
Contents.
auto backgroundData() const -> DataHandle
Background data or DataHandle::Null.

Function documentation

Magnum::Ui::Panel::Panel(Anchor anchor, PanelStyle style = PanelStyle::Default) explicit

Constructor.

Parameters
anchor Positioning anchor
style Panel style

Magnum::Ui::Panel::Panel(NonOwnedT, Anchor anchor, PanelStyle style = PanelStyle::Default) explicit

Construct a non-owned panel.

Like Panel(Anchor, PanelStyle) but the widget node doesn't get removed on destruction. Instead, it gets removed either once any parent node is removed, or when AbstractUserInterface::removeNode() is explicitly called on node().

Magnum::Ui::Panel::Panel(NoCreateT) explicit

Construct with no underlying node.

The instance is equivalent to a moved-out state, i.e. not usable for anything. Move another instance over it to make it useful.

Panel& Magnum::Ui::Panel::setStyle(PanelStyle style)

Set style.

Returns Reference to self (for method chaining)

Panel& Magnum::Ui::Panel::setStyle(PanelStyle style, Nanoseconds time)

Set style at given time.

Returns Reference to self (for method chaining)

Compared to setStyle(PanelStyle) may animate the style transition if the theme defines an animation for it. The style() getter is however updated immediately always.

Anchor Magnum::Ui::Panel::contents() const

Contents.

Use the returned anchor to put widgets inside the panel.

DataHandle Magnum::Ui::Panel::backgroundData() const

Background data or DataHandle::Null.

Exposed mainly for testing purposes, not meant to be modified directly.