Struct ToolbarLocation 

pub struct ToolbarLocation {

    pub label: String,
    pub shorter: Vec<String>,
    pub value: String,
    pub placeholder: String,
    pub icon: Option<String>,
    pub editable: bool,
    pub name: String,
    pub go_name: String,
    pub segments: Vec<LocationSegment>,
    pub image: Option<ToolbarImage>,
    pub suggestions: Vec<LocationSuggestion>,
    pub choices: Vec<LocationChoice>,
    pub anchor: Option<String>,
    pub edited: bool,
    pub view_only: bool,
}

Where the window is and can go.

Fields

label: String

What the bar shows at rest: a page’s domain, a folder, a document.

shorter: Vec<String>

Narrower forms of the label, widest first, each saying the same (a period’s Jun 29 – Jul 5 for Mon, Jun 29 – Sun, Jul 5): where the label does not fit, the bar shows the widest of them that fits the room the location has once everything else it can fold is in the menu, and keeps that room for it, so a wider window never shows a narrower form. Only the last is ever elided.

value: String

What an edit starts from: the whole address. Empty means the label.

placeholder: String

The field’s hint while it is empty (“Search or enter address”).

icon: Option<String>

The location’s own icon, by its icon-set name (a lock for a secure page); the bar shows the app’s icon when there is none.

editable: bool

A click or Ctrl+L turns it into a field.

name: String

The field’s accessible name (“Address and search”).

go_name: String

The go button’s name (“Go”).

segments: Vec<LocationSegment>

The location’s levels, outermost first, for a breadcrumb in place of the label (a folder’s path). Empty: the label.

image: Option<ToolbarImage>

The location’s own picture (a page’s favicon), shown at the bar’s leading edge instead of the app’s icon.

suggestions: Vec<LocationSuggestion>

What the bar lists under the field while it is edited, best first: the app’s answer to the text it heard last (ToolbarEvent::Edit).

choices: Vec<LocationChoice>

The places the location can be switched to, for a location that is one of a few (where a terminal’s shell runs): the label reads as a picker and a click opens the menu of them. Choosing one commits its value (ToolbarEvent::Commit). Empty: no picker. Not for an editable location, which edits instead.

anchor: Option<String>

Where in the app the window is, as the app’s open action takes it (a search entry’s anchor): the desktop reopens it there, from the launcher’s Continue. None: the app cannot be opened at it.

edited: bool

The document the location names has changes not yet saved: the bar says so after the label, in words, and tells assistive technology the same. Every editor marks its unsaved document this one way.

view_only: bool

The person may only look at what the location names: the bar says “View only” after the label, in place of Self::edited, and tells assistive technology the same. Set by the window’s framework from what the person may do there (show_view_only), not by the app.

Implementations

impl ToolbarLocation

pub fn period(period: Period) -> ToolbarLocation

A location naming period (crate::format::Period), in its widest form, with its narrower ones for a narrow bar.

pub fn form(&self, form: usize) -> &str

The label (0) or its narrower form form, the narrowest past the last.

pub fn edit_value(&self) -> &str

The text an edit starts from.

Trait Implementations

impl Clone for ToolbarLocation

fn clone(&self) -> ToolbarLocation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ToolbarLocation

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for ToolbarLocation

fn default() -> ToolbarLocation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolbarLocation

fn deserialize<__D>( __deserializer: __D, ) -> Result<ToolbarLocation, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolbarLocation

fn eq(&self, other: &ToolbarLocation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ToolbarLocation

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ToolbarLocation

impl StructuralPartialEq for ToolbarLocation