RSX Code Reference
    Preparing search index...

    Class CloudSyncStatusWindow

    A callout window displaying the contents of the current sync status.

    Hierarchy (View Summary)

    Index
    onActionAdded: (newAction: WatchdogAction) => void

    Gets called whenever a new WatchdogAction was added to the list.

    _bottomBarContentSpacing: number

    The spacing between the separator and the bottom buttons area.

    _buttonTotalHeight: number

    The height of each button on the bottom area.

    _buttonTotalWidth: number

    The width of each button on the bottom area.

    _iconButtonSize: number

    The size of the each icon in the bottom buttons.

    _listEntryHeight: number

    The height of each entry on the list.

    _minimumButtomLabelSize: number

    The minimum height of the label inside each bottom button.

    _minimumScrollAreaHeight: number

    The minimum size of the Scroll area with the main content.

    _syncStatusIconSize: number

    The size of the sync status icon.

    _titleToContentSpacing: number

    The spacing between the title content to the main scroll area.

    defaultSpacing: number

    Default spacing between one element to another.

    kMaximumActionCount: number

    The maximum Watchdog Actions count possible in the queue before deleting old actions.

    • get dpiScale(): number

      Returns the DPI scale factor.

      Returns number

      The DPI scale is in relation to a 1x base resolution of 75 DPI.

    • get height(): number

      Sets the height of the window in points.

      Returns number

    • set height(value: number): void

      Parameters

      • value: number

      Returns void

    • get heightInPixels(): number

      Sets the height of the window in pixels.

      Returns number

    • set heightInPixels(value: number): void

      Parameters

      • value: number

      Returns void

    • get isDestroyed(): boolean

      Check whether the window was destroyed.

      Returns boolean

    • get isFocused(): boolean

      Checks whether the window currently has keyboard focus.

      Returns boolean

    • set isFocused(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get keyWindow(): KeyWindowBase

      Gets the key window which owns this window.

      Returns KeyWindowBase

    • get left(): number

      Returns the X position of the window in screen coordinates in points.

      Returns number

    • get localShortcutContext(): ShortcutContext

      Specifies the local shortcut context. This context will be automatically disabled whenever the user switches focus from the context.

      Returns ShortcutContext

    • get renderWindow(): RenderWindow

      Gets the RenderWindow associated with this EditorWindow.

      Returns RenderWindow

    • get shortcutContext(): ShortcutContext

      Specifies the global shortcut context. This context will be always enabled as long as the window is active.

      Returns ShortcutContext

    • get styleSheet(): StyleSheet

      Sets the stylesheet for this window's UI surface.

      Returns StyleSheet

    • set styleSheet(value: StyleSheet): void

      Sets the stylesheet for this window's UI surface.

      Parameters

      Returns void

    • get top(): number

      Returns the X position of the window in screen coordinates in points.

      Returns number

    • get width(): number

      Sets the width of the window in points.

      Returns number

    • set width(value: number): void

      Parameters

      • value: number

      Returns void

    • get widthInPixels(): number

      Sets the width of the window in pixels.

      Returns number

    • set widthInPixels(value: number): void

      Parameters

      • value: number

      Returns void

    • Centers the window within it's parent window.

      Returns void

    • Clears the watchdog history.

      Returns void

    • Closes and destroys the window.

      Returns void

    • Fill the initial list view with the current Action History, and update the last catalog update received.

      Returns void

    • Determines if the window is visible.

      Returns boolean

    • Mark the current watchdog history list view as dirty.

      Returns void

    • Virtual

      Called whenever the user or the program requested to close the window.

      Returns void

    • Virtual

      Method to override to implement destruction of custom windows. Called by the engine before the window is destroyed.

      Returns void

    • Virtual

      Method to override to implement custom behavior of a window, called by the engine once per frame.

      Returns void

    • Virtual

      Method to override to implement custom behavior of a window, called by the engine once per frame, once all the windows had their onEditorUpdate() method called.

      Returns void

    • Virtual

      Method to override to implement initialization of custom windows. Called by the engine after window creation.

      Parameters

      • options: any

      Returns void

    • Virtual

      Called whenever window visibility changed.

      Parameters

      • isVisible: boolean

      Returns void

      Implementing classes must call super.

    • Virtual

      Triggered whenever the window gains or loses focus.

      Parameters

      • inFocus: boolean

        True if focus was gained, false otherwise.

      Returns void

    • Virtual

      Triggered whenever the window size changes.

      Parameters

      • width: number

        New width of the window in pixels.

      • height: number

        New height of the window in pixels.

      Returns void

    • Defines the window maximum width and height in points.

      Parameters

      • maxWidth: number
      • maxHeight: number

      Returns void

    • Defines the window minimum width and height in points.

      Parameters

      • minWidth: number

        The minimum width of the window in points.

      • minHeight: number

        The minimum height of the window in points.

      Returns void

    • Moves the window on the desktop. Coordinates are in screen space using points.

      Parameters

      • x: number
      • y: number

      Returns void

    • Moves the window on the desktop. Coordinates are in screen space using pixels.

      Parameters

      • x: number
      • y: number

      Returns void

    • Resizes the window using a width and height in points.

      Parameters

      • width: number
      • height: number

      Returns void

    • Resizes the window using a width and height in pixels.

      Parameters

      • width: number
      • height: number

      Returns void

    • Updates the UI elements with the last catalog fetch action.

      Parameters

      Returns void

    • Updates the UI Entry representing the given finished action. If the action was in the list already marked as in-progress, it will be removed and a new one added instead. If no action was present before, a new entry will be added.

      Parameters

      Returns void

    • Clears the current content of the watchdog action list from memory.

      Returns void

    • Checks if the given two watchdog actions represents the same Entry in the list. If they represent the same actual user "action", but only changes its complete state, they should be represented in the same Entry in the list.

      Parameters

      Returns boolean

    • Checks if the given Watchdog Entry is from a type that should be processed by the window.

      Parameters

      Returns boolean

    • Checks if the given Watchdog Entry is from a type that should be displayed in the main List View. Some actions should not be presented to the user, use this to make sure an action should.

      Parameters

      Returns boolean

    • Loads the watchdog actions list from cache (if any).

      Returns void

    • Saves the current watchdog actions list to disk.

      Returns void

    • Updates the list with the latest actions.

      Returns boolean

      Whether or not new items were added to the list in this update.

    onWatchdogActionAdded: Event<[WatchdogAction]>

    Gets called once a Watchdog Action is added to the history of actions list.

    onFocusChangedInternal: Event<[isFocused: boolean]>