Module controls 

Action-bound controls: the capability a widget provides when it owns an ActionEmitter (a button, a checkbox, a custom painted control), and the walks the host uses to reach every control in a retained tree.

A widget that provides ActionControls answers for its whole subtree: its overrides decide which children to reach, through the walks below. The trait defaults do what an ordinary container does, so an override names only what differs.

Macros

optional_emitter_controls

The custody, drain and availability ActionControls methods of a widget whose only producer is its optional self.action emitter. Pass custody to leave availability to a widget that refreshes it itself.

Enums

Origin

Who asked for a queued invocation on this device.

Traits

ActionControls

Functions

action_control_bindings

The action-emitter portion of the current exposed inventory. Ordinary widgets contribute only semantic bindings, so visit their children without materializing accessibility. Capability overrides retain private custody.

children_action_control_bindings

The action-emitter bindings of widget’s exposed children. A wrapper’s own bindings are semantic and never consume action availability, so this is a wrapper’s whole action inventory without materializing accessibility.

children_have_action_control_bindings

Whether any of widget’s exposed children contain controls consuming action availability; the counterpart of children_action_control_bindings.

control_action_bindings

The control inventory of widget’s subtree.

has_action_control_bindings

Whether widget’s subtree contains controls consuming action availability.

has_pending_control_invocation

Whether a control intent under widget waits on startup preparation.

install_control_custody

Bind every retained control producer under widget.

note_drained_origin

Say, while the host drains it, who asked for the invocation a queue is handing over (see Origin). A queue that says nothing hands over a person’s invocation.

on_control_invocation_result

Report a control invocation’s admission result through widget’s subtree.

on_control_invocation_result_for

on_control_invocation_result for a submission that continues the operation on_behalf_of, which result_on_behalf_of names meanwhile.

refresh_control_action_availability

Push the permission-filtered action surface into every control under widget.

result_on_behalf_of

The operation the result being reported continues, while a host reports one: the invocation of the effect that submitted the edit, which waits for it to land. None for a submission nobody waits on.

start_pending_control_invocations

Run the queued control intents of a tree whose host keeps no resource tree of its own, such as the shell’s own UI: an intent is delivered to the control that published the action it names — a press (Button::on_effect, Button::on_view) and a control’s own verb (the value a field reports, the choice a picker made) alike — as a resource host delivers an admitted invocation. Answers how many ran.

take_attributed_control_invocation

take_control_invocation, with the effect invocation the intent continues (ActionControls::take_attributed_control_invocation).

take_control_invocation

Drain one queued control intent from widget’s subtree.

Type Aliases

AttributedControlInvocation

A control intent and the effect invocation it continues, when an effect’s handler or completion queued it.

ControlResult

How the host answered a control’s invocation: started (done at once with its output, or accepted to finish later), or refused.