Gambas Documentation
Application Repository
Code Snippets
Compilation & Installation
Components
gb
gb.args
gb.cairo
gb.chart
gb.clipper
gb.complex
gb.compress
gb.crypt
gb.data
gb.db
gb.db.form
gb.db.mysql
gb.db.odbc
gb.db.postgresql
gb.db.sqlite2
gb.db.sqlite3
gb.dbus
gb.dbus.trayicon
gb.debug
gb.desktop
_Desktop_Passwords
_Desktop_ScreenSaver
_desktop_windows
_desktopvirtual
Desktop
_get
ActiveWindow
CacheDir
ConfigDir
Count
Current
DataDir
find ?
FindWindow
getdesktopdirectory ?
GetDirectory
GetFileIcon
Is
NetworkAvailable
Open
OpenTerminal
Passwords
Path
RemoteDisplay
RootWindow
RunAs
RunAsRoot
RuntimeDir
ScreenSaver
SendKeys
SendMail
Showing
Type
Types
Windows
DesktopFile
DesktopMime
desktopwatcher
desktopwindow
gb.desktop.gnome.keyring
gb.desktop.x11
gb.eval
gb.eval.highlight
gb.form
gb.form.dialog
gb.form.editor
gb.form.htmlview
gb.form.mdi
gb.form.print
gb.form.stock
gb.form.terminal
gb.gmp
gb.gsl
gb.gtk
gb.gtk.opengl
gb.gtk3
gb.gtk3.opengl
gb.gtk3.webview
gb.gui
gb.gui.opengl
gb.gui.qt
gb.gui.qt.opengl
gb.gui.qt.webkit
gb.gui.trayicon
gb.gui.webview
gb.hash
gb.highlight
gb.image
gb.image.effect
gb.image.imlib
gb.image.io
gb.inotify
gb.jit
gb.libxml
gb.logging
gb.map
gb.markdown
gb.media
gb.media.form
gb.memcached
gb.mime
gb.mysql
gb.ncurses
gb.net
gb.net.curl
gb.net.pop3
gb.net.smtp
gb.openal
gb.opengl
gb.opengl.glsl
gb.opengl.glu
gb.opengl.sge
gb.openssl
gb.option
gb.pcre
gb.pdf
gb.poppler
gb.qt4
gb.qt4.ext
gb.qt4.opengl
gb.qt4.webkit
gb.qt4.webview
gb.qt5
gb.qt5.ext
gb.qt5.opengl
gb.qt5.webkit
gb.qt5.webview
gb.report
gb.report2
gb.scanner
gb.sdl
gb.sdl.sound
gb.sdl2
gb.sdl2.audio
gb.settings
gb.signal
gb.term
gb.test
gb.util
gb.util.web
gb.v4l
gb.vb
gb.web
gb.web.feed
gb.web.form
gb.web.gui
gb.xml
gb.xml.html
gb.xml.rpc
gb.xml.xslt
Controls pictures
Deprecated components
Developer Documentation
Development Environment Documentation
Documents
Error Messages
Gambas Playground
How To's
Language Index
Language Overviews
Last Changes
Lexicon
README
Search the wiki
To Do
Topics
Tutorials
Wiki License
Wiki Manual

Desktop (gb.desktop)

This class allows you to use desktop-agnostic routines based on the freedesktop standards and xdg-utils project.

This class reimplements Desktop in gb.qt4.

This class is static.

This class acts like a read-only static array.

Inherited constants
Charset   Returns the charset used by the graphical interface for displaying text.

Static properties
ActiveWindow   Returns or sets the current active top-level window.
CacheDir   Return the base directory relative to which user specific non-essential data files should be stored.
ConfigDir   Return the base directory relative to which user specific configuration files should be stored.
Count   Returns or sets the number or virtual desktops.
Current   Returns or sets the current virtual desktop.
DataDir   Return the base directory relative to which user specific data files should be stored.
NetworkAvailable   Returns True if any network interface (other than the loopback) is available.
Passwords   Returns a virtual object that allows to use the password storage of the current desktop environment.
Path   Returns the path of the desktop.
RemoteDisplay   Return if the current desktop is remote.
RootWindow   Returns the X11 handle of the root window.
RuntimeDir   Return the base directory relative to which user-specific non-essential runtime files and other file objects (such as sockets, named pipes, ...) should be stored.
ScreenSaver   Manages the screen saver.
Showing   Returns or sets if the "show desktop" flag is set.
UsePortal  
Windows   Returns a virtual object that represents the list of all top-level windows.

Inherited static properties
H   A synonymous of the Height property.
HasSystemTray   Return if the desktop has a system tray.
Height   Return the height of the usable desktop rectangle displayed on the default monitor.
Platform   Return the underlying desktop platform.
Resolution   Returns the desktop screen resolution in DPI.
Scale   Returns half of the height of the default desktop font in pixels.
Type   Return the current desktop environment name.
Types  
W   A synonymous of the Width property.
Width   Return the width of the usable desktop rectangle displayed on the default monitor.
X   Return the left coordinate of the usable desktop rectangle displayed on the default monitor.
Y   Return the top coordinate of the usable desktop rectangle displayed on the default monitor.

Static methods
FindWindow   Find all X11 top-level window that match the specified criteria.
GetDirectory   Return the desktop directory specified in its Type argument.
GetFileIcon   Return the icon associated with a specific file.
Open   Opens a file or URL in the user's preferred application.
OpenTerminal   Opens a terminal emulator.
PickColor  
RunAs   Run the specified Command as another UserName, by using the desktop-specific tool if possible.
RunAsRoot   Run the specified Command as root, by using the desktop-specific tool if possible.
Screenshot  
SendKeys   Send fake keyboard events to the window having the focus.
SendMail   Sends a mail by using your graphical mail client.

Inherited static methods
Is  

If you are running your application as root with sudo.

XDG does not give the same results for a root user and can have unexpected results when trying to use gb.desktop functions.

Using -E with sudo can help by preserving the user env variables making them accesible to your application and gb.desktop.

eg.
# sudo -E $HOME/Myapp/Myapp.gambas