DocumentSignalName

public enum DocumentSignalName : String, SignalNameProtocol

Undocumented

Show on GitHub

  • The ‘load-complete’ signal is emitted when a pending load of a static document has completed. This signal is to be expected by ATK clients if and when AtkDocument implementors expose ATK_STATE_BUSY. If the state of an AtkObject which implements AtkDocument does not include ATK_STATE_BUSY, it should be safe for clients to assume that the AtkDocument’s static contents are fully loaded into the container. (Dynamic document contents should be exposed via other signals.)

    Declaration

    Swift

    case loadComplete = "load-complete"
    Show on GitHub

  • The ‘load-stopped’ signal is emitted when a pending load of document contents is cancelled, paused, or otherwise interrupted by the user or application logic. It should not however be emitted while waiting for a resource (for instance while blocking on a file or network read) unless a user-significant timeout has occurred.

    Declaration

    Swift

    case loadStopped = "load-stopped"
    Show on GitHub

  • The ‘page-changed’ signal is emitted when the current page of a document changes, e.g. pressing page up/down in a document viewer.

    Declaration

    Swift

    case pageChanged = "page-changed"
    Show on GitHub

  • The ‘reload’ signal is emitted when the contents of a document is refreshed from its source. Once ‘reload’ has been emitted, a matching ‘load-complete’ or ‘load-stopped’ signal should follow, which clients may await before interrogating ATK for the latest document content.

    Declaration

    Swift

    case reload = "reload"
    Show on GitHub