Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
titleDescription

Creates an additional Desktop in a new frame. For more details, see the Multi-Monitor Clients page.

Info

This function accepts  keyword arguments.



Panel
titleClient Permission Restrictions

This scripting function has no Client Permission restrictions.


Panel
titleSyntax

system.gui.openDesktop (screen, handle, title, width, height, x, y, windows)

  • Parameters

Integer screen - The screen index of which screen to place the new frame on. If omitted, screen 0 will be used.

String handle   - A name for the desktop. If omitted, the screen index will be used.

String title  - The title for the new frame. If omitted, the index handle will be used. If the handle and title are omitted, the screen index will be used.

Integer width - The width for the new Desktop's frame. If omitted, frame will become maximized on the specified monitor.

Integer height - The width for the new desktop's frame. If omitted, frame will become maximized on the specified monitor.

Integer x - The X coordinate for the new desktop's frame. Only used if both width and height are specified. If omitted, defaults to 0.

Integer y - The Y coordinate for the new desktop's frame. Only used if both width and height are specified. If omitted, defaults to 0.

PySequence windows - A list of window paths to open in the new Desktop frame.

  • Returns

JFrame  - A reference to the new Desktop frame.

  • Scope

Client



Panel
titleCode Examples


Code Block
languagepy
titleCode Snippet
#Create a list of window paths to open in the new desktop
windowsToOpen = ["Main Windows/Main Window", "Navigation"]

#Creates a new desktop. The desktop will open the windows listed above. 
system.gui.openDesktop(windows=windowsToOpen)


Code Block
languagepy
titleCode Snippet
#Creates a new desktop on monitor 0 (primary) with only the Overview window open
system.gui.openDesktop(screen=0, windows=["Overview"])


Code Block
languagepy
titleCode Snippet
#Creates a new desktop on monitor 0 (primary) with only the Overview window open.
#Including a handle gives the new desktop a name. This is useful for using other desktop scripting functions
system.gui.openDesktop(screen=0, handle="Left Monitor", windows=["Overview"])