class new in Git master
#include <Magnum/Ui/UserInterface.h>
UserInterface Main user interface.
Provides an interface for setting up and querying BaseLayer and TextLayer instances for use by builtin widgets. You'll most likely instantiate the class through UserInterfaceGL, which populates the instance with concrete OpenGL implementations of the renderer and builtin layers.
Base classes
- class AbstractUserInterface new in Git master
- Base for the main user interface.
Derived classes
- class UserInterfaceGL new in Git master
- OpenGL implementation of the main user interface.
Constructors, destructors, conversion operators
- UserInterface(const UserInterface&) deleted
- Copying is not allowed.
- UserInterface(UserInterface&&) noexcept
- Move constructor.
Public functions
- auto operator=(const UserInterface&) -> UserInterface& deleted
- Copying is not allowed.
- auto operator=(UserInterface&&) -> UserInterface& noexcept
- Move assignment.
- auto hasBaseLayer() const -> bool
- Whether a base layer instance has been set.
- auto baseLayer() -> BaseLayer&
- Base layer instance.
- auto baseLayer() const -> const BaseLayer&
-
auto setBaseLayerInstance(Containers::
Pointer<BaseLayer>&& instance) -> UserInterface& - Set a base layer instance.
- auto hasTextLayer() const -> bool
- Whether a text layer instance has been set.
- auto textLayer() -> TextLayer&
- Text layer instance.
- auto textLayer() const -> const TextLayer&
-
auto setTextLayerInstance(Containers::
Pointer<TextLayer>&& instance) -> UserInterface& - Set a text layer instance.
- auto hasEventLayer() const -> bool
- Whether an event layer instance has been set.
- auto eventLayer() -> EventLayer&
- Event layer instance.
- auto eventLayer() const -> const EventLayer&
-
auto setEventLayerInstance(Containers::
Pointer<EventLayer>&& instance) -> UserInterface& - Set an event layer instance.
- auto hasSnapLayouter() const -> bool
- Whether a snap layouter instance has been set.
- auto snapLayouter() -> SnapLayouter&
- Snap layouter instance.
- auto snapLayouter() const -> const SnapLayouter&
-
auto setSnapLayouterInstance(Containers::
Pointer<SnapLayouter>&& instance) -> UserInterface& - Set a snap layouter instance.
Function documentation
Magnum:: Ui:: UserInterface:: UserInterface(UserInterface&&) noexcept
Move constructor.
Performs a destructive move, i.e. the original object isn't usable afterwards anymore.
bool Magnum:: Ui:: UserInterface:: hasBaseLayer() const
Whether a base layer instance has been set.
BaseLayer& Magnum:: Ui:: UserInterface:: baseLayer()
Base layer instance.
Expects that an instance has been set, either by setBaseLayerInstance() or transitively by UserInterfaceGL::
UserInterface& Magnum:: Ui:: UserInterface:: setBaseLayerInstance(Containers:: Pointer<BaseLayer>&& instance)
Set a base layer instance.
Returns | Reference to self (for method chaining) |
---|
Expects that the instance hasn't been set yet, either by this function or transitively either by UserInterfaceGL::
bool Magnum:: Ui:: UserInterface:: hasTextLayer() const
Whether a text layer instance has been set.
TextLayer& Magnum:: Ui:: UserInterface:: textLayer()
Text layer instance.
Expects that an instance has been set, either by setTextLayerInstance() or transitively by UserInterfaceGL::
UserInterface& Magnum:: Ui:: UserInterface:: setTextLayerInstance(Containers:: Pointer<TextLayer>&& instance)
Set a text layer instance.
Returns | Reference to self (for method chaining) |
---|
Expects that the instance hasn't been set yet, either by this function or transitively either by UserInterfaceGL::
bool Magnum:: Ui:: UserInterface:: hasEventLayer() const
Whether an event layer instance has been set.
EventLayer& Magnum:: Ui:: UserInterface:: eventLayer()
Event layer instance.
Expects that an instance has been set, either by setEventLayerInstance() or transitively by UserInterfaceGL::
const EventLayer& Magnum:: Ui:: UserInterface:: eventLayer() const
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
UserInterface& Magnum:: Ui:: UserInterface:: setEventLayerInstance(Containers:: Pointer<EventLayer>&& instance)
Set an event layer instance.
Returns | Reference to self (for method chaining) |
---|
Expects that the instance hasn't been set yet, either by this function or transitively either by UserInterfaceGL::
bool Magnum:: Ui:: UserInterface:: hasSnapLayouter() const
Whether a snap layouter instance has been set.
SnapLayouter& Magnum:: Ui:: UserInterface:: snapLayouter()
Snap layouter instance.
Expects that an instance has been set, either by setSnapLayouterInstance() or transitively by UserInterfaceGL::
const SnapLayouter& Magnum:: Ui:: UserInterface:: snapLayouter() const
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
UserInterface& Magnum:: Ui:: UserInterface:: setSnapLayouterInstance(Containers:: Pointer<SnapLayouter>&& instance)
Set a snap layouter instance.
Returns | Reference to self (for method chaining) |
---|
Expects that the instance hasn't been set yet, either by this function or transitively either by UserInterfaceGL::