Interface nsILayoutHistoryStateType

Hierarchy

Properties

hasStates

Methods

AddRef AddState GetContents GetState HasStates QueryInterface Release RemoveState Reset ResetScrollState SetScrollPositionOnly addNewPresState getPresState

Properties

Readonly hasStates

hasStates: boolean

Whether this LayoutHistoryState contains any PresStates.

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

AddState

  • Set |aState| as the state object for |aKey|. This transfers_ownership of |aState| to the LayoutHistoryState. It will be freed when RemoveState() is called or when the LayoutHistoryState is destroyed.

    Parameters

    • aKey: nsCString
    • aState: PresStateUnique

    Returns void

GetContents

  • Get the contents of the layout history.

    Parameters

    • aScrollPositionOnly: boolean
    • aKeys: invalid
    • aStates: invalid

    Returns void

GetState

  • Look up the state object for |aKey|.

    Parameters

    • aKey: nsCString

    Returns PresStatePtr

HasStates

  • Check whether this history has any states in it

    Returns boolean

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

RemoveState

  • Remove the state object for |aKey|.

    Parameters

    • aKey: nsCString

    Returns void

Reset

  • Remove all the states and clear the scroll position only flag.

    Returns void

ResetScrollState

  • Resets PresState::GetScrollState of all PresState objects to 0,0.

    Returns void

SetScrollPositionOnly

  • Sets whether this history can contain only scroll position history or all possible history

    Parameters

    • aFlag: constBool

    Returns void

addNewPresState

  • Constructs a new PresState object based on the supplied data and adds it to the LayoutHistoryState.

    Parameters

    • aKey: string
    • aScrollX: number
    • aScrollY: number
    • aAllowScrollOriginDowngrade: boolean
    • aRes: number

    Returns void

getPresState

  • Attempts to get the data of the PresState corresponding to the passed key. Throws if no data could be found.

    Parameters

    • aKey: string
    • aScrollX: number
    • aScrollY: number
    • aAllowScrollOriginDowngrade: boolean
    • aRes: number

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc