Struct xpcom::interfaces::nsIPartialSHistory [] [src]

#[repr(C)]
pub struct nsIPartialSHistory { /* fields omitted */ }

interface nsIPartialSHistory : nsISupports

/**
 * nsIPartialSHistory represents a part of nsIGroupedSHistory. It associates to
 * a "partial" nsISHistory in either local or remote process.
 */

Methods

impl nsIPartialSHistory
[src]

[src]

Cast this nsIPartialSHistory to one of its base interfaces.

impl nsIPartialSHistory
[src]

STATE_INACTIVE: i64 = 0

STATE_ACTIVE: i64 = 1

STATE_PRERENDER: i64 = 2

[src]

[infallible] readonly attribute unsigned long count;

[src]

[infallible] readonly attribute long globalIndex;

[src]

[infallible] readonly attribute unsigned long globalIndexOffset;

[src]

readonly attribute nsIFrameLoader ownerFrameLoader;

[src]

readonly attribute nsIGroupedSHistory groupedSHistory;

[src]

[infallible] attribute long activeState;

[src]

[infallible] attribute long activeState;

[src]

/**
   * Notify that it's been added to a grouped session history. It also implies
   * it's becoming the active partial history of the group.
   *
   * @param aGroup                 The GroupedSHistory which this partialSHistory
   *                               is joining.
   *
   * @param aOffset                The number of entries in preceding partial
   *                               session histories.
   */

void onAttachGroupedSHistory (in nsIGroupedSHistory aGroup, in unsigned long aOffset);

[src]

/**
   * This method is used by the TabParent to notify the PartialSHistory
   * that the state of its corresponding nsISHistory in the content process
   * has been updated. It is unused in the in-process case.
   *
   * @param aCount      The number of entries in the associated session history.
   * @param aLocalIndex The local index of the currently active entry in the
   *                    associated session history
   */

void handleSHistoryUpdate (in unsigned long aCount, in unsigned long aLocalIndex, in boolean aTruncate);

[src]

/**
   * Notify that the partial session history has been swapped in as the active
   * session history. Only an active session history can possibly add / remove /
   * replace its history entries.
   *
   * @param aGlobalLength      The up-to-date global length.
   * @param aTargetLocalIndex  The local index to navigate to.
   */

void onActive (in unsigned long aGlobalLength, in unsigned long aTargetLocalIndex);

[src]

/**
   * Notify that the partial session history has been swapped out and is no
   * longer active.
   */

void onDeactive ();

Methods from Deref<Target = nsISupports>

[src]

Cast this nsISupports to one of its base interfaces.

[src]

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

[src]

[noscript,notxpcom] nsrefcnt AddRef ();

[src]

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsIPartialSHistory
[src]

IID: nsIID = nsID(1557618216, 33676, 18954, [151, 46, 96, 5, 247, 54, 239, 122])

[src]

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise. Read more

impl RefCounted for nsIPartialSHistory
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIPartialSHistory
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.