morph::ui::GridWidget Class Reference

Children laid out row-major in columns. More...

#include <backend.hpp>

Inheritance diagram for morph::ui::GridWidget:

Public Member Functions
virtual void	setColumns (int columns)=0
	Sets the column count.
virtual void	setGap (int gap)=0
	Sets the space between cells.
virtual void	setSpan (Widget &child, int span)=0
	Sets how many columns a child spans; a child spans one until this is called.
virtual void	setAlign (Align align)=0
	Places each cell's content vertically in its row. A new grid stretches it; a child's own alignSelf wins.
Public Member Functions inherited from morph::ui::ContainerWidget
virtual void	moveChild (Widget &child, std::size_t index)=0
	Moves child to position index: it is removed, then inserted before the child now at index.
Public Member Functions inherited from morph::ui::Widget
	Widget (Widget const &)=delete
Widget &	operator= (Widget const &)=delete
	Widget (Widget &&)=delete
Widget &	operator= (Widget &&)=delete
virtual void	setVisible (bool visible)=0
	Shows or hides the widget and everything inside it.
virtual void	setEnabled (bool enabled)=0
	Enables or disables input on the widget and everything inside it.
virtual void	setLayout (LayoutHints const &hints)=0
	Sets the size request.
virtual void	setDragKey (std::optional< Key > const &key)=0
	Makes the widget draggable, carrying key, or not draggable.
virtual void	setDropHandler (std::function< bool(Key const &)> accepts, std::function< void(Key)> onDrop)=0
	Makes the widget a drop target.
virtual void	setAccessibleName (std::string_view name)=0
	Sets the name assistive technology reads for the widget.
virtual void	setAccessibleRole (std::string_view role)=0
	Sets the role assistive technology announces for the widget.
virtual void	setTestId (std::string_view testId)=0
	Sets the stable identifier an automated test finds the widget by.
virtual void	setTooltip (std::string_view text)=0
	Sets the text shown while the pointer rests on the widget.
virtual void	setSurface (std::string_view surface)=0
	Styles the widget and everything inside it with a named token set of the theme.
virtual void	setKeys (std::vector< std::string > const &chords, std::function< void(std::string)> onChord)=0
	Declares the keyboard chords the widget handles while focus is inside it.
virtual void	focus ()=0
	Moves keyboard focus to the widget.
virtual void	setOnHover (std::function< void()> onHover)
	Calls onHover each time the pointer comes to rest over the widget. A backend without a pointer, or one that does not report hovering, keeps the default, which never calls it: hovering is a hint, such as a prefetch, never something a widget relies on.

Detailed Description

Children laid out row-major in columns.

Definition at line 326 of file backend.hpp.

Member Function Documentation

setColumns()

virtual void morph::ui::GridWidget::setColumns ( int columns )

pure virtual

Sets the column count.

Parameters

columns

At least one.

Implemented in morph::ui::testing::detail::FakeGrid.

setGap()

virtual void morph::ui::GridWidget::setGap ( int gap )

pure virtual

Sets the space between cells.

Parameters

gap	A spacing step, 0 to kMaxSpacingStep; the mount never passes another value.

Implemented in morph::ui::testing::detail::FakeGrid.

setSpan()

virtual void morph::ui::GridWidget::setSpan ( Widget & child, int span )

pure virtual

Sets how many columns a child spans; a child spans one until this is called.

Parameters

child	One of this grid's children.
span	The column count it occupies.

Implemented in morph::ui::testing::detail::FakeGrid.

setAlign()

virtual void morph::ui::GridWidget::setAlign ( Align align )

pure virtual

Places each cell's content vertically in its row. A new grid stretches it; a child's own alignSelf wins.

Parameters

align

Where it sits.

Implemented in morph::ui::testing::detail::FakeGrid.

---

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

• morph/ui/backend.hpp