Struct stdweb::web::event::PopStateEvent
[−]
[src]
pub struct PopStateEvent(_);
A PopStateEvent
is dispatched to the window every time the active history entry changes
between two history entries for the same document. If the history entry being activated was
created by a call to history.push_state()
or was affected by a call to
history.replace_state()
, the PopStateEvent
's state property contains a copy of the history
entry's state object.
Note that just calling history.push_state()
or history.replace_state()
won't trigger a
PopStateEvent
. The PopStateEvent
is only triggered by doing a browser action such as a
clicking on the back button (or calling history.back()
). And the event is only
triggered when the user navigates between two history entries for the same document.
Browsers tend to handle the PopStateEvent
differently on page load. Chrome and Safari always
emit a PopStateEvent
on page load, but Firefox doesn't.
Methods
impl PopStateEvent
[src]
pub fn state(&self) -> Value
[src]
The state object associated to the new history entry, if that entry was created with push_state or affected by replace_state.
Example usage:
let state: Option<MyStruct> = event.state().try_into().ok();
Trait Implementations
impl Clone for PopStateEvent
[src]
fn clone(&self) -> PopStateEvent
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Debug for PopStateEvent
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl PartialEq for PopStateEvent
[src]
fn eq(&self, __arg_0: &PopStateEvent) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &PopStateEvent) -> bool
[src]
This method tests for !=
.
impl Eq for PopStateEvent
[src]
impl InstanceOf for PopStateEvent
[src]
fn instance_of(reference: &Reference) -> bool
[src]
Checks whenever a given Reference if of type Self
.
impl AsRef<Reference> for PopStateEvent
[src]
impl ReferenceType for PopStateEvent
[src]
unsafe fn from_reference_unchecked(reference: Reference) -> Self
[src]
Converts a given reference into a concrete reference-like wrapper. Doesn't do any type checking; highly unsafe to use! Read more
impl From<PopStateEvent> for Reference
[src]
fn from(value: PopStateEvent) -> Self
[src]
Performs the conversion.
impl TryFrom<PopStateEvent> for Reference
[src]
type Error = Void
The type returned in the event of a conversion error.
fn try_from(value: PopStateEvent) -> Result<Self, Self::Error>
[src]
Performs the conversion.
impl TryFrom<Reference> for PopStateEvent
[src]
type Error = ConversionError
The type returned in the event of a conversion error.
fn try_from(reference: Reference) -> Result<Self, Self::Error>
[src]
Performs the conversion.
impl<'_r> TryFrom<&'_r Reference> for PopStateEvent
[src]
type Error = ConversionError
The type returned in the event of a conversion error.
fn try_from(reference: &Reference) -> Result<Self, Self::Error>
[src]
Performs the conversion.
impl TryFrom<Value> for PopStateEvent
[src]
type Error = ConversionError
The type returned in the event of a conversion error.
fn try_from(value: Value) -> Result<Self, Self::Error>
[src]
Performs the conversion.
impl<'_r> TryFrom<&'_r Value> for PopStateEvent
[src]
type Error = ConversionError
The type returned in the event of a conversion error.
fn try_from(value: &Value) -> Result<Self, Self::Error>
[src]
Performs the conversion.
impl JsSerialize for PopStateEvent
[src]
impl IEvent for PopStateEvent
[src]
fn bubbles(&self) -> bool
[src]
Indicates whether this event bubbles upward through the DOM. Read more
fn cancel_bubble(&self) -> bool
[src]
A historical alias to Event.stopPropagation()
. Read more
fn set_cancel_bubble(&self, value: bool)
[src]
A historical alias to Event.stopPropagation()
. Setting this to true
before returning from an event handler will stop propagation of the event. Read more
fn cancelable(&self) -> bool
[src]
Indicates whether the event is cancelable. Read more
fn current_target(&self) -> Option<EventTarget>
[src]
A reference to the currently registered target of this event. Read more
fn default_prevented(&self) -> bool
[src]
Indicates whether preventDefault
has been called on this event. Read more
fn event_phase(&self) -> EventPhase
[src]
Indicates which phase of event flow is currently being evaluated. Read more
fn stop_immediate_propagation(&self)
[src]
Prevents any further listeners from being called for this event. Read more
fn stop_propagation(&self)
[src]
Stops the propagation of this event to descendants in the DOM. Read more
fn target(&self) -> Option<EventTarget>
[src]
Returns a reference to the target to which this event was originally registered. Read more
fn time_stamp(&self) -> Option<f64>
[src]
Returns the time in milliseconds at which this event was created. Read more
fn is_trusted(&self) -> bool
[src]
Indicates whether the event was generated by a user action.
fn event_type(&self) -> String
[src]
Returns a string containing the type of event. It is set when the event is constructed and is the name commonly used to refer to the specific event. Read more
fn prevent_default(&self)
[src]
Cancels the event if it is cancelable, without stopping further propagation of the event. Read more
impl ConcreteEvent for PopStateEvent
[src]
const EVENT_TYPE: &'static str
EVENT_TYPE: &'static str = "popstate"
A string representing the event type. Read more