About Window

AboutWindow

class firefox_puppeteer.ui.about_window.window.AboutWindow(marionette, window_handle)

Representation of the About window.

close(callback=None, force=False)

Closes the current chrome window.

If this is the last remaining window, the Marionette session is ended.

Parameters:
  • callback – Optional, function to trigger the window to open. It is triggered with the current BaseWindow as parameter. Defaults to window.open().
  • force – Optional, forces the closing of the window by using the Gecko API. Defaults to False.
closed

Returns closed state of the chrome window.

Returns:True if the window has been closed.
deck

The Deck instance which represents the deck.

Returns:Reference to the deck.
focus()

Sets the focus to the current chrome window.

focused

Returns True if the chrome window is focused.

Returns:True if the window is focused.
handle

Returns the window handle of the chrome window.

Returns:window handle.
loaded

Checks if the window has been fully loaded.

Returns:True, if the window is loaded.
localize_entity(entity_id)

Returns the localized string for the specified DTD entity id.

Parameters:entity_id – The id to retrieve the value from.
Returns:The localized string for the requested entity.
Raises:MarionetteException – When entity id is not found.
localize_property(property_id)

Returns the localized string for the specified property id.

Parameters:property_id – The id to retrieve the value from.
Returns:The localized string for the requested property.
Raises:MarionetteException – When property id is not found.
menubar

Provides access to the menu bar, for example, the File menu.

See the MenuBar reference.

open_window(callback=None, expected_window_class=None, focus=True)

Opens a new top-level chrome window.

Parameters:
  • callback – Optional, function to trigger the window to open. It is triggered with the current BaseWindow as parameter. Defaults to window.open().
  • expected_class – Optional, check for the correct window class.
  • focus – Optional, if true, focus the new window. Defaults to True.
send_shortcut(command_key, **kwargs)

Sends a keyboard shortcut to the window.

Parameters:
  • command_key – The key (usually a letter) to be pressed.
  • accel – Optional, If True, the Accel modifier key is pressed. This key differs between OS X (Meta) and Linux/Windows (Ctrl). Defaults to False.
  • alt – Optional, If True, the Alt modifier key is pressed. Defaults to False.
  • ctrl – Optional, If True, the Ctrl modifier key is pressed. Defaults to False.
  • meta – Optional, If True, the Meta modifier key is pressed. Defaults to False.
  • shift – Optional, If True, the Shift modifier key is pressed. Defaults to False.
switch_to(focus=False)

Switches the context to this chrome window.

By default it will not focus the window. If that behavior is wanted, the focus parameter can be used.

Parameters:focus – If True, the chrome window will be focused.
Returns:Current window as BaseWindow instance.
window_element

Returns the inner DOM window element.

Returns:DOM window element.

Deck

class firefox_puppeteer.ui.about_window.deck.Deck(marionette, window, element)
apply

The ApplyPanel instance for the apply panel.

Returns:ApplyPanel instance.
check_for_updates

The CheckForUpdatesPanel instance for the check for updates panel.

Returns:CheckForUpdatesPanel instance.
checking_for_updates

The CheckingForUpdatesPanel instance for the checking for updates panel.

Returns:CheckingForUpdatesPanel instance.
download_and_install

The DownloadAndInstallPanel instance for the download and install panel.

Returns:DownloadAndInstallPanel instance.
download_failed

The DownloadFailedPanel instance for the download failed panel.

Returns:DownloadFailedPanel instance.
downloading

The DownloadingPanel instance for the downloading panel.

Returns:DownloadingPanel instance.
element

Returns the reference to the underlying DOM element.

Returns:Reference to the DOM element
no_updates_found

The NoUpdatesFoundPanel instance for the no updates found panel.

Returns:NoUpdatesFoundPanel instance.
panels

List of all the Panel instances of the current deck.

Returns:List of Panel instances.
selected_index

The index of the currently selected panel.

Returns:Index of the selected panel.
selected_panel

A Panel instance of the currently selected panel.

Returns:Panel instance.
window

Returns the reference to the chrome window.

Returns:BaseWindow instance of the chrome window.

ApplyPanel

class firefox_puppeteer.ui.about_window.deck.ApplyPanel(marionette, window, element)
button

The DOM element which represents the Update button.

Returns:Reference to the button element.
element

Returns the reference to the underlying DOM element.

Returns:Reference to the DOM element
window

Returns the reference to the chrome window.

Returns:BaseWindow instance of the chrome window.

CheckForUpdatesPanel

class firefox_puppeteer.ui.about_window.deck.CheckForUpdatesPanel(marionette, window, element)
button

The DOM element which represents the Check for Updates button.

Returns:Reference to the button element.
element

Returns the reference to the underlying DOM element.

Returns:Reference to the DOM element
window

Returns the reference to the chrome window.

Returns:BaseWindow instance of the chrome window.

CheckingForUpdatesPanel

class firefox_puppeteer.ui.about_window.deck.CheckingForUpdatesPanel(marionette, window, element)
element

Returns the reference to the underlying DOM element.

Returns:Reference to the DOM element
window

Returns the reference to the chrome window.

Returns:BaseWindow instance of the chrome window.

DownloadAndInstallPanel

class firefox_puppeteer.ui.about_window.deck.DownloadAndInstallPanel(marionette, window, element)
button

The DOM element which represents the Download button.

Returns:Reference to the button element.
element

Returns the reference to the underlying DOM element.

Returns:Reference to the DOM element
window

Returns the reference to the chrome window.

Returns:BaseWindow instance of the chrome window.

DownloadFailedPanel

class firefox_puppeteer.ui.about_window.deck.DownloadFailedPanel(marionette, window, element)
element

Returns the reference to the underlying DOM element.

Returns:Reference to the DOM element
window

Returns the reference to the chrome window.

Returns:BaseWindow instance of the chrome window.

DownloadingPanel

class firefox_puppeteer.ui.about_window.deck.DownloadingPanel(marionette, window, element)
element

Returns the reference to the underlying DOM element.

Returns:Reference to the DOM element
window

Returns the reference to the chrome window.

Returns:BaseWindow instance of the chrome window.