design-lint: props: derive the setters of ui-patterns components (#[prop]) and drop the hand setters

This commit is contained in:
aiongg
2026-11-16 13:27:45 +00:00
parent 394579be1c
commit bc9b545e5f
2 changed files with 25 additions and 62 deletions
@@ -225,7 +225,8 @@ pub struct ParamDialog<'a> {
/// The patterns the dialog's [`ParamKind::Pattern`] rows offer.
#[prop]
patterns: Cow<'a, [PresetRow<String>]>,
/// A muted line at the footer's start edge (JPEG Options' size estimate).
/// A muted line at the footer's start edge, left of the buttons (a file size estimate, say).
#[prop(into)]
footer_note: Option<Label>,
/// A section under the rows that only reads the values (a monitor note).
#[prop(func = "Fn(&mut Ui, &DialogFields)")]
@@ -234,19 +235,24 @@ pub struct ParamDialog<'a> {
/// The host's answers to the requests of earlier passes; the dialog writes them into its values first.
#[prop]
answers: Vec<HostAnswer>,
/// The values a [`HostedParamDialog`] opened before the first pass: the first pass leaves them and Reset restores
/// them.
/// Marks the bound values as opened by the host with `opening`, so the first pass doesn't open them again and
/// Reset restores `opening`.
#[prop]
values_opened: Option<DialogFields>,
/// OK keeps the dialog open and reports its answer in `ParamDialogOutput::held` ([`HostedParamDialog::held_ok`]).
/// Makes OK keep the dialog open and report its answer in `ParamDialogOutput::held`.
#[prop(name = "hold_ok")]
hold: bool,
/// The host accepted the held OK: this pass closes the dialog as OK.
/// Closes the dialog as OK in this pass: the host accepted the held answer.
#[prop]
finish_held: bool,
/// Why the host refused the held OK, and the values it refused: the notice under the rows shows while the values
/// are those.
/// Shows `reason` under the rows while the values are `refused`.
#[prop]
refusal: Option<(Label, DialogFields)>,
/// The picture point this pass centres the preview pane's view on ([`HostedParamDialog::centre_preview`]).
/// Centres the preview pane's view on the picture point `point` in this pass; without a picture it does nothing.
#[prop(name = "centre_on")]
centre: Option<Pos2>,
/// The colours a child picker previews in the colour rows, by row key ([`HostedParamDialog::preview_color`]).
/// The colours the colour rows show in place of their values in this pass, by row key.
#[prop]
preview_colors: Vec<(String, Srgba)>,
}
@@ -314,43 +320,6 @@ impl<'a> ParamDialog<'a> {
self
}
/// Marks the bound values as opened by the host with `opening`, so the first pass doesn't open them again and
/// Reset restores `opening`.
pub(crate) fn values_opened(mut self, opening: DialogFields) -> Self {
self.values_opened = Some(opening);
self
}
/// Makes OK keep the dialog open and report its answer in `ParamDialogOutput::held`.
fn hold_ok(mut self, on: bool) -> Self {
self.hold = on;
self
}
/// Closes the dialog as OK in this pass: the host accepted the held answer.
fn finish_held(mut self, on: bool) -> Self {
self.finish_held = on;
self
}
/// Shows `reason` under the rows while the values are `refused`.
fn refusal(mut self, refusal: Option<(Label, DialogFields)>) -> Self {
self.refusal = refusal;
self
}
/// Centres the preview pane's view on the picture point `point` in this pass; without a picture it does nothing.
fn centre_on(mut self, point: Option<Pos2>) -> Self {
self.centre = point;
self
}
/// The colours the colour rows show in place of their values in this pass, by row key.
fn preview_colors(mut self, colors: Vec<(String, Srgba)>) -> Self {
self.preview_colors = colors;
self
}
/// The answer OK gives with `fields`: with `remember`, it keeps the part of them the dialog saves.
fn result(key: String, params: &[Param], remember: Option<SaveKey>, fields: DialogFields) -> ParamResult {
let remember = remember.map(|save| (save, Self::remembered(params, &fields)));
@@ -612,12 +581,6 @@ impl<'a> ParamDialog<'a> {
preview_centre: shown_preview.centre,
}
}
/// A muted line at the footer's start edge, left of the buttons (a file size estimate, say).
pub fn footer_note(mut self, note: impl Into<Label>) -> Self {
self.footer_note = Some(note.into());
self
}
}
/// What the footer of an installed Reset footer reads from the body.
@@ -1125,9 +1088,13 @@ impl StackDialog for HostedParamDialog {
.opened(Bind::bound(&mut self.open))
.hold_ok(self.hold)
.finish_held(finish)
.refusal(self.held.refusal().map(|(reason, refused)| (reason.clone(), refused.fields.clone())))
.preview_colors(self.requests.previewed_colors().to_vec())
.centre_on(centre);
.preview_colors(self.requests.previewed_colors().to_vec());
if let Some((reason, refused)) = self.held.refusal() {
dialog = dialog.refusal((reason.clone(), refused.fields.clone()));
}
if let Some(point) = centre {
dialog = dialog.centre_on(point);
}
// OK waits for the host's answer: a second OK cannot file over the held one.
if self.held.is_waiting() {
dialog = dialog.ok_enabled(false);
@@ -79,6 +79,9 @@ pub struct ReportDialog<'a> {
title: Label,
summary: Label,
notes: Vec<ReportNote>,
/// Plain `lines` shown as the notes, in place of ones built with [`ReportNote`]: each line is selectable text,
/// and Copy hands them back as they are.
#[prop]
lines: Vec<Label>,
/// Binds the open state to `open`.
#[prop(name = "opened")]
@@ -91,13 +94,6 @@ impl<'a> ReportDialog<'a> {
ReportDialog { title: title.into(), summary: summary.into(), notes, lines: Vec::new(), open: None }
}
/// Plain `lines` shown as the notes, in place of ones built with [`ReportNote`]: each line is selectable text,
/// and Copy hands them back as they are.
pub fn lines(mut self, lines: Vec<Label>) -> Self {
self.lines = lines;
self
}
/// The notes as the Copy button hands them back, one per line with the tone's word first; plain
/// [`lines`](ReportDialog::lines) one per line as they are.
pub fn as_text(&self, env: &Env) -> String {