pub struct QuestionnaireState { /* private fields */ }Expand description
Owns questionnaire answers, validation, navigation and focus state.
Implementations§
Source§impl QuestionnaireState
impl QuestionnaireState
pub fn new( items: Vec<QuestionnaireItemDefinition>, cx: &mut Context<'_, QuestionnaireState>, ) -> Result<QuestionnaireState, QuestionnaireSchemaError>
pub fn with_current_item( self, name: impl Into<SharedString>, ) -> Result<QuestionnaireState, QuestionnaireSchemaError>
pub fn with_shortcuts( self, mode: QuestionnaireShortcutMode, ) -> QuestionnaireState
pub fn current_item(&self) -> Option<&SharedString>
pub fn current_ix(&self) -> Option<usize>
pub fn total(&self) -> usize
pub fn progress(&self) -> QuestionnaireProgressState
pub fn item_definition( &self, name: &str, ) -> Option<&QuestionnaireItemDefinition>
pub fn choice_definition( &self, item: &str, value: &str, ) -> Option<&QuestionnaireChoiceDefinition>
pub fn item_state(&self, name: &str) -> Option<QuestionnaireItemState>
pub fn choice_state( &self, item: &str, value: &str, ) -> Option<QuestionnaireChoiceState>
Sourcepub fn choice_position(&self, item: &str, value: &str) -> Option<(usize, usize)>
pub fn choice_position(&self, item: &str, value: &str) -> Option<(usize, usize)>
One-based position of a choice among its item’s enabled choices, with the enabled total. Assistive technology announces the pair.
pub fn answer(&self, name: &str) -> Option<QuestionnaireAnswer>
pub fn answers(&self) -> QuestionnaireAnswers
Sourcepub fn error(&self, name: &str) -> Option<&QuestionnaireValidationError>
pub fn error(&self, name: &str) -> Option<&QuestionnaireValidationError>
The active validation failure for an item, if any. Base reports the reason; the presentation layer turns a built-in reason into text.
pub fn is_complete(&self) -> bool
pub fn input_state( &self, name: &str, ) -> Option<Entity<InputBaseState<InputMode>>>
pub fn focus_handle(&self) -> &FocusHandle
pub fn item_focus_handle(&self, name: &str) -> Option<&FocusHandle>
pub fn choice_focus_handle( &self, item: &str, value: &str, ) -> Option<&FocusHandle>
pub fn is_current_input_focused(&self, window: &Window) -> bool
Sourcepub fn current_input_has_text(&self, cx: &App) -> bool
pub fn current_input_has_text(&self, cx: &App) -> bool
Whether the active item’s freeform input currently holds text. The skin needs it to decide whether an arrow key moves focus or edits the draft.
pub fn focused_current_choice(&self, window: &Window) -> Option<&SharedString>
pub fn shortcut_mode(&self) -> Option<QuestionnaireShortcutMode>
pub fn shortcut_for_choice( &self, item: &str, value: &str, ) -> Option<SharedString>
pub fn choice_for_shortcut( &self, item: &str, key: &str, ) -> Option<&SharedString>
pub fn activate_shortcut( &mut self, key: &str, window: &mut Window, cx: &mut Context<'_, QuestionnaireState>, ) -> bool
pub fn set_current_item( &mut self, name: &str, window: &mut Window, cx: &mut Context<'_, QuestionnaireState>, ) -> Result<(), QuestionnaireSchemaError>
pub fn set_answer( &mut self, item: &str, answer: QuestionnaireAnswer, window: &mut Window, cx: &mut Context<'_, QuestionnaireState>, ) -> Result<(), QuestionnaireSchemaError>
pub fn set_input_value( &mut self, item: &str, value: impl Into<SharedString>, window: &mut Window, cx: &mut Context<'_, QuestionnaireState>, ) -> Result<(), QuestionnaireSchemaError>
pub fn set_item_disabled( &mut self, name: &str, disabled: bool, window: &mut Window, cx: &mut Context<'_, QuestionnaireState>, ) -> Result<(), QuestionnaireSchemaError>
pub fn set_choice_disabled( &mut self, item: &str, value: &str, disabled: bool, cx: &mut Context<'_, QuestionnaireState>, ) -> Result<(), QuestionnaireSchemaError>
pub fn set_external_error( &mut self, item: &str, error: impl Into<SharedString>, cx: &mut Context<'_, QuestionnaireState>, ) -> Result<(), QuestionnaireSchemaError>
pub fn clear_external_error( &mut self, item: &str, cx: &mut Context<'_, QuestionnaireState>, ) -> Result<(), QuestionnaireSchemaError>
pub fn reset( &mut self, window: &mut Window, cx: &mut Context<'_, QuestionnaireState>, )
pub fn activate_choice( &mut self, item: &str, value: &str, cx: &mut Context<'_, QuestionnaireState>, ) -> Result<(), QuestionnaireSchemaError>
pub fn confirm_current( &mut self, window: &mut Window, cx: &mut Context<'_, QuestionnaireState>, ) -> bool
pub fn go_previous( &mut self, window: &mut Window, cx: &mut Context<'_, QuestionnaireState>, ) -> bool
pub fn go_next( &mut self, window: &mut Window, cx: &mut Context<'_, QuestionnaireState>, ) -> bool
pub fn skip_current( &mut self, window: &mut Window, cx: &mut Context<'_, QuestionnaireState>, ) -> bool
pub fn submit( &mut self, window: &mut Window, cx: &mut Context<'_, QuestionnaireState>, ) -> bool
pub fn focus_current_item(&self, window: &mut Window, cx: &mut App) -> bool
pub fn focus_invalid_item( &self, item: &str, window: &mut Window, cx: &mut App, ) -> bool
pub fn focus_choice( &self, item: &str, value: &str, window: &mut Window, cx: &mut App, ) -> bool
pub fn focus_input(&self, item: &str, window: &mut Window, cx: &mut App) -> bool
pub fn focus_previous_answer( &mut self, window: &mut Window, cx: &mut Context<'_, QuestionnaireState>, ) -> bool
pub fn focus_next_answer( &mut self, window: &mut Window, cx: &mut Context<'_, QuestionnaireState>, ) -> bool
pub fn move_current_radio( &mut self, direction: isize, window: &mut Window, cx: &mut Context<'_, QuestionnaireState>, ) -> bool
Trait Implementations§
Auto Trait Implementations§
impl !RefUnwindSafe for QuestionnaireState
impl !Send for QuestionnaireState
impl !Sync for QuestionnaireState
impl !UnwindSafe for QuestionnaireState
impl Freeze for QuestionnaireState
impl Unpin for QuestionnaireState
impl UnsafeUnpin for QuestionnaireState
Blanket Implementations§
Source§impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
Source§fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
👎Deprecated since 0.7.7:
replaced by palette::chromatic_adaptation::AdaptIntoUnclamped
Convert the source color to the destination color using the specified
method.
Source§fn adapt_into(self) -> D
fn adapt_into(self) -> D
👎Deprecated since 0.7.7:
replaced by palette::chromatic_adaptation::AdaptIntoUnclamped
Convert the source color to the destination color using the bradford
method by default.
Source§impl<T, C> AdaptIntoUnclamped<T> for Cwhere
T: AdaptFromUnclamped<C>,
impl<T, C> AdaptIntoUnclamped<T> for Cwhere
T: AdaptFromUnclamped<C>,
Source§type Scalar = <T as AdaptFromUnclamped<C>>::Scalar
type Scalar = <T as AdaptFromUnclamped<C>>::Scalar
The number type that’s used as the color’s components.
Source§fn adapt_into_unclamped_with<M>(self) -> Twhere
M: LmsToXyz<<C as AdaptIntoUnclamped<T>>::Scalar> + XyzToLms<<C as AdaptIntoUnclamped<T>>::Scalar>,
fn adapt_into_unclamped_with<M>(self) -> Twhere
M: LmsToXyz<<C as AdaptIntoUnclamped<T>>::Scalar> + XyzToLms<<C as AdaptIntoUnclamped<T>>::Scalar>,
Source§impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
Source§fn arrays_from(colors: C) -> T
fn arrays_from(colors: C) -> T
Cast a collection of colors into a collection of arrays.
Source§impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
Source§fn arrays_into(self) -> C
fn arrays_into(self) -> C
Cast this collection of arrays into a collection of colors.
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
Source§type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
The number type that’s used in
parameters when converting.Source§fn cam16_into_unclamped(
self,
parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>,
) -> T
fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T
Converts
self into C, using the provided parameters.impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
Source§fn components_from(colors: C) -> T
fn components_from(colors: C) -> T
Cast a collection of colors into a collection of color components.
Source§impl<T, C> ComponentsInto<C> for T
impl<T, C> ComponentsInto<C> for T
Source§fn components_into(self) -> C
fn components_into(self) -> C
Cast this collection of color components into a collection of colors. Read more
Source§impl<T> FromAngle<T> for T
impl<T> FromAngle<T> for T
Source§fn from_angle(angle: T) -> T
fn from_angle(angle: T) -> T
Performs a conversion from
angle.Source§impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
Source§fn from_stimulus(other: U) -> T
fn from_stimulus(other: U) -> T
Converts
other into Self, while performing the appropriate scaling,
rounding and clamping.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
Source§fn into_angle(self) -> U
fn into_angle(self) -> U
Performs a conversion into
T.Source§impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
Source§type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
The number type that’s used in
parameters when converting.Source§fn into_cam16_unclamped(
self,
parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>,
) -> T
fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T
Converts
self into C, using the provided parameters.Source§impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
Source§fn into_color(self) -> U
fn into_color(self) -> U
Convert into T with values clamped to the color defined bounds Read more
Source§impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
Source§fn into_color_unclamped(self) -> U
fn into_color_unclamped(self) -> U
Convert into T. The resulting color might be invalid in its color space Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoStimulus<T> for T
impl<T> IntoStimulus<T> for T
Source§fn into_stimulus(self) -> T
fn into_stimulus(self) -> T
Converts
self into T, while performing the appropriate scaling,
rounding and clamping.Source§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
Source§type Error = <C as TryFromComponents<T>>::Error
type Error = <C as TryFromComponents<T>>::Error
The error for when
try_into_colors fails to cast.Source§fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
Try to cast this collection of color components into a collection of
colors. Read more
Source§impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
Source§fn try_into_color(self) -> Result<U, OutOfBounds<U>>
fn try_into_color(self) -> Result<U, OutOfBounds<U>>
Convert into T, returning ok if the color is inside of its defined
range, otherwise an
OutOfBounds error is returned which contains
the unclamped color. Read moreSource§impl<C, U> UintsFrom<C> for Uwhere
C: IntoUints<U>,
impl<C, U> UintsFrom<C> for Uwhere
C: IntoUints<U>,
Source§fn uints_from(colors: C) -> U
fn uints_from(colors: C) -> U
Cast a collection of colors into a collection of unsigned integers.
Source§impl<C, U> UintsInto<C> for Uwhere
C: FromUints<U>,
impl<C, U> UintsInto<C> for Uwhere
C: FromUints<U>,
Source§fn uints_into(self) -> C
fn uints_into(self) -> C
Cast this collection of unsigned integers into a collection of colors.