pub struct SettingPage { /* private fields */ }Expand description
A setting page that can contain multiple setting groups.
Implementations§
Source§impl SettingPage
impl SettingPage
pub fn new(title: impl Into<SharedString>) -> Self
Sourcepub fn title(self, title: impl Into<SharedString>) -> Self
pub fn title(self, title: impl Into<SharedString>) -> Self
Set the title of the setting page.
Sourcepub fn title_suffix<F, E>(self, suffix: F) -> Self
pub fn title_suffix<F, E>(self, suffix: F) -> Self
Set a custom element to render after the title in the page header.
For example, an info icon button that opens the help documentation.
Sourcepub fn description(self, description: impl Into<SharedString>) -> Self
pub fn description(self, description: impl Into<SharedString>) -> Self
Set the description of the setting page, default is None.
Sourcepub fn default_open(self, default_open: bool) -> Self
pub fn default_open(self, default_open: bool) -> Self
Set the default open state of the setting page, default is false.
Sourcepub fn resettable(self, resettable: bool) -> Self
pub fn resettable(self, resettable: bool) -> Self
Set whether the setting page is resettable, default is true.
If true and the items in this page has changed, the reset button will appear.
Sourcepub fn group(self, group: SettingGroup) -> Self
pub fn group(self, group: SettingGroup) -> Self
Add a setting group to the page.
Sourcepub fn groups(self, groups: impl IntoIterator<Item = SettingGroup>) -> Self
pub fn groups(self, groups: impl IntoIterator<Item = SettingGroup>) -> Self
Add multiple setting groups to the page.
Sourcepub fn header_style(self, style: &StyleRefinement) -> Self
pub fn header_style(self, style: &StyleRefinement) -> Self
Set the style refinement for the header of the setting page.
Trait Implementations§
Source§impl Clone for SettingPage
impl Clone for SettingPage
Source§fn clone(&self) -> SettingPage
fn clone(&self) -> SettingPage
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl !RefUnwindSafe for SettingPage
impl !Send for SettingPage
impl !Sync for SettingPage
impl !UnwindSafe for SettingPage
impl Freeze for SettingPage
impl Unpin for SettingPage
impl UnsafeUnpin for SettingPage
Blanket Implementations§
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<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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> 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 more