morph::ui::DropZoneWidget Class Reference

A region that takes files dropped from the operating system. More...

#include <backend.hpp>

Inheritance diagram for morph::ui::DropZoneWidget:

Public Member Functions
virtual void	setAccept (std::vector< std::string > const &extensions)=0
	Sets the extensions it takes; called once.
virtual void	setMultiple (bool multiple)=0
	Sets whether a drop may carry more than one file; called once.
virtual void	setOnDrop (std::function< void(std::vector< std::string >)> onDrop)=0
	Sets what a drop it takes calls. A drop with a file outside the accepted extensions, or with several files when only one is taken, is refused whole and calls nothing.
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

A region that takes files dropped from the operating system.

Definition at line 755 of file backend.hpp.

Member Function Documentation

setAccept()

virtual void morph::ui::DropZoneWidget::setAccept ( std::vector< std::string > const & extensions )

pure virtual

Sets the extensions it takes; called once.

Parameters

extensions

Such as ".csv", compared without regard to case; empty takes every file.

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

setMultiple()

virtual void morph::ui::DropZoneWidget::setMultiple ( bool multiple )

pure virtual

Sets whether a drop may carry more than one file; called once.

Parameters

multiple

Whether several files are taken at once.

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

setOnDrop()

virtual void morph::ui::DropZoneWidget::setOnDrop ( std::function< void(std::vector< std::string >)> onDrop )

pure virtual

Sets what a drop it takes calls. A drop with a file outside the accepted extensions, or with several files when only one is taken, is refused whole and calls nothing.

Parameters

onDrop

The handler, given the paths in the order dropped; empty does nothing.

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

---

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

• morph/ui/backend.hpp