Standard Widget Toolkit for GTK 3.125.0 · org.eclipse.swt.graphics.Device

Field Summary

Modifier and Type	Field and Description
protected static final int	CHANGE_SCALEFACTOR
pack-priv Color	COLOR_BLACK
pack-priv Color	COLOR_BLUE
pack-priv Color	COLOR_CYAN
pack-priv Color	COLOR_DARK_BLUE
pack-priv Color	COLOR_DARK_CYAN
pack-priv Color	COLOR_DARK_GRAY
pack-priv Color	COLOR_DARK_GREEN
pack-priv Color	COLOR_DARK_MAGENTA
pack-priv Color	COLOR_DARK_RED
pack-priv Color	COLOR_DARK_YELLOW
pack-priv Color	COLOR_GRAY
pack-priv Color	COLOR_GREEN
pack-priv Color	COLOR_MAGENTA
pack-priv Color	COLOR_RED
pack-priv Color	COLOR_TRANSPARENT
pack-priv Color	COLOR_WHITE
pack-priv Color	COLOR_YELLOW
protected static Device	CurrentDevice
public static boolean	DEBUG
pack-priv boolean	debug
protected static Runnable	DeviceFinder
pack-priv static Device[]	Devices
pack-priv long	displaySettings
pack-priv volatile boolean	disposed
pack-priv Point	dpi
pack-priv long	emptyTab
pack-priv Error[]	errors
pack-priv Callback	gsettingsCallback
pack-priv long	gsettingsProc
pack-priv int[]	handler_ids
pack-priv boolean	isConnected
pack-priv String[]	log_domains
pack-priv Callback	logCallback
pack-priv long	logProc
pack-priv Object[]	objects
pack-priv long	shellHandle
pack-priv Font	systemFont
pack-priv boolean	tracking
pack-priv Object	trackingLock
pack-priv int	warningLevel
protected long	xDisplay the handle to the X Display (Warning: This field is platform dependent) Important Note This field is not part of the SWT public API.
pack-priv static Callback	XErrorCallback
pack-priv static long	XErrorProc
pack-priv static Callback	XIOErrorCallback
pack-priv static long	XIOErrorProc
pack-priv static long	XNullErrorProc
pack-priv static long	XNullIOErrorProc

Constructor Summary

Access	Constructor and Description
public	Device() Constructs a new instance of this class.
public	Device(DeviceData the DeviceData which describes the receiver data) Constructs a new instance of this class.

Method Summary

Modifier and Type	Method and Description
protected void	checkDevice() Throws an `SWTException` if the receiver can not be accessed by the caller.
protected void	create(DeviceData the DeviceData which describes the receiver data) Creates the device in the operating system.
pack-priv static synchronized void	deregister(Device device)
protected void	destroy() Destroys the device in the operating system and releases the device's handle.
public void	dispose() Disposes of the operating system resources associated with the receiver.
pack-priv void	dispose_Object(Object object)
pack-priv static synchronized Device	findDevice(long xDisplay)
public Rectangle	Returns: the bounding rectangle getBounds() Returns a rectangle describing the receiver's size and location.
private Rectangle	getBoundsInPixels()
public Rectangle	Returns: the client area getClientArea() Returns a rectangle which describes the area of the receiver which is capable of displaying data.
public int	Returns: the depth of the screen getDepth() Returns the bit depth of the screen, which is the number of bits it takes to represent the number of unique colors that the screen is currently capable of displaying.
pack-priv static synchronized Device	getDevice()
public DeviceData	Returns: a `DeviceData` containing the device's data and attributes getDeviceData() Returns a `DeviceData` based on the receiver.
protected int	Returns: zoom in percentage getDeviceZoom() Gets the scaling factor from the device and calculates the zoom level.
public Point	Returns: the horizontal and vertical DPI getDPI() Returns a point whose x coordinate is the logical horizontal dots per inch of the display, and whose y coordinate is the logical vertical dots per inch of the display.
public FontData[]	Returns: the matching font data getFontList(String the name of the font to look for, or null faceName, boolean if true only scalable fonts are returned, otherwise only non-scalable fonts are returned. scalable) Returns `FontData` objects which describe the fonts that match the given arguments.
pack-priv Point	getScreenDPI()
public Color	Returns: the matching color getSystemColor(int the color constant id) Returns the matching standard color for the given constant, which should be one of the color constants specified in class `SWT`.
public Font	Returns: a font getSystemFont() Returns a reasonable font for applications to use.
public boolean	Returns: `true`if warnings are being handled, and `false` otherwise getWarnings() Returns `true` if the underlying window system prints out warning messages on the console, and `setWarnings` had previously been called with `true`.
protected void	init() Initializes any internal resources needed by the device.
public abstract void	internal_dispose_GC(long the platform specific GC handle hDC, GCData the platform specific GC data data) Redeclares org.eclipse.swt.graphics.Drawable.internal_dispose_GC. Invokes platform specific functionality to dispose a GC handle.
public abstract long	Returns: the platform specific GC handle internal_new_GC(GCData the platform specific GC data data) Redeclares org.eclipse.swt.graphics.Drawable.internal_new_GC. Invokes platform specific functionality to allocate a new GC handle.
public boolean	Returns: `true` when the device is disposed and `false` otherwise isDisposed() Returns `true` if the device has been disposed, and `false` otherwise.
public boolean	isTracking()
public boolean	Returns: whether the font was successfully loaded loadFont(String the font file path path) Loads the font specified by a file.
pack-priv long	logProc(long log_domain, long log_level, long message, long user_data)
pack-priv void	new_Object(Object object)
private void	overrideThemeValues() For functionality & improved looks, we override some CSS theme values with custom values.
pack-priv static synchronized void	register(Device device)
protected void	release() Releases any internal resources back to the operating system and clears all fields except the device handle.
public void	setTracking(boolean tracking)
public void	setWarnings(boolean `true`if warnings should be printed, and `false` otherwise warnings) If the underlying window system supports printing warning messages to the console, setting warnings to `false` prevents these messages from being printed.
private void	startTracking()
private void	stopTracking()
pack-priv static long	XErrorProc(long xDisplay, long xErrorEvent)
pack-priv static long	XIOErrorProc(long xDisplay)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

CHANGE_SCALEFACTOR	back to summary
protected static final int CHANGE_SCALEFACTOR Since 3.105

COLOR_BLACK	back to summary
pack-priv Color COLOR_BLACK

COLOR_BLUE	back to summary
pack-priv Color COLOR_BLUE

COLOR_CYAN	back to summary
pack-priv Color COLOR_CYAN

COLOR_DARK_BLUE	back to summary
pack-priv Color COLOR_DARK_BLUE

COLOR_DARK_CYAN	back to summary
pack-priv Color COLOR_DARK_CYAN

COLOR_DARK_GRAY	back to summary
pack-priv Color COLOR_DARK_GRAY

COLOR_DARK_GREEN	back to summary
pack-priv Color COLOR_DARK_GREEN

COLOR_DARK_MAGENTA	back to summary
pack-priv Color COLOR_DARK_MAGENTA

COLOR_DARK_RED	back to summary
pack-priv Color COLOR_DARK_RED

COLOR_DARK_YELLOW	back to summary
pack-priv Color COLOR_DARK_YELLOW

COLOR_GRAY	back to summary
pack-priv Color COLOR_GRAY

COLOR_GREEN	back to summary
pack-priv Color COLOR_GREEN

COLOR_MAGENTA	back to summary
pack-priv Color COLOR_MAGENTA

COLOR_RED	back to summary
pack-priv Color COLOR_RED

COLOR_TRANSPARENT	back to summary
pack-priv Color COLOR_TRANSPARENT

COLOR_WHITE	back to summary
pack-priv Color COLOR_WHITE

COLOR_YELLOW	back to summary
pack-priv Color COLOR_YELLOW

CurrentDevice	back to summary
protected static Device CurrentDevice

DEBUG	back to summary
public static boolean DEBUG

debug	back to summary
pack-priv boolean debug

DeviceFinder	back to summary
protected static Runnable DeviceFinder

Devices	back to summary
pack-priv static Device[] Devices

displaySettings	back to summary
pack-priv long displaySettings

disposed	back to summary
pack-priv volatile boolean disposed

dpi	back to summary
pack-priv Point dpi

emptyTab	back to summary
pack-priv long emptyTab

errors	back to summary
pack-priv Error[] errors

gsettingsCallback	back to summary
pack-priv Callback gsettingsCallback

gsettingsProc	back to summary
pack-priv long gsettingsProc

handler_ids	back to summary
pack-priv int[] handler_ids

isConnected	back to summary
pack-priv boolean isConnected

log_domains	back to summary
pack-priv String[] log_domains

logCallback	back to summary
pack-priv Callback logCallback

logProc	back to summary
pack-priv long logProc

objects	back to summary
pack-priv Object[] objects

shellHandle	back to summary
pack-priv long shellHandle

systemFont	back to summary
pack-priv Font systemFont

tracking	back to summary
pack-priv boolean tracking

trackingLock	back to summary
pack-priv Object trackingLock

warningLevel	back to summary
pack-priv int warningLevel

xDisplay	back to summary
protected long xDisplay the handle to the X Display (Warning: This field is platform dependent) Important Note This field is not part of the SWT public API. It is marked protected only so that it can be shared within the packages provided by SWT. It is not available on all platforms and should never be accessed from application code.

XErrorCallback	back to summary
pack-priv static Callback XErrorCallback

XErrorProc	back to summary
pack-priv static long XErrorProc

XIOErrorCallback	back to summary
pack-priv static Callback XIOErrorCallback

XIOErrorProc	back to summary
pack-priv static long XIOErrorProc

XNullErrorProc	back to summary
pack-priv static long XNullErrorProc

XNullIOErrorProc	back to summary
pack-priv static long XNullIOErrorProc

Constructor Detail

Device back to summary

public Device()

Constructs a new instance of this class.

You must dispose the device when it is no longer required.

Since: 3.1
See Also: create, init

Device back to summary

public Device(DeviceData data)

Constructs a new instance of this class.

You must dispose the device when it is no longer required.

Parameters

data:DeviceData: the DeviceData which describes the receiver

See Also

create, init, DeviceData

Method Detail

checkDevice back to summary

protected void checkDevice()

Throws an SWTException if the receiver can not be accessed by the caller. This may include both checks on the state of the receiver and more generally on the entire execution context. This method should be called by device implementors to enforce the standard SWT invariants.

Currently, it is an error to invoke any method (other than isDisposed() and dispose()) on a device that has had its dispose() method called.

In future releases of SWT, there may be more or fewer error checks and exceptions may be thrown for different reasons.

Exceptions

SWTException:

ERROR_WIDGET_DISPOSED - if the receiver has been disposed

create back to summary

protected void create(DeviceData data)

Creates the device in the operating system. If the device does not have a handle, this method may do nothing depending on the device.

This method is called before init.

Subclasses are supposed to reimplement this method and not call the super implementation.

Parameters

data:DeviceData: the DeviceData which describes the receiver

See Also

init

deregister	back to summary
pack-priv static synchronized void deregister(Device device)

destroy back to summary

protected void destroy()

Destroys the device in the operating system and releases the device's handle. If the device does not have a handle, this method may do nothing depending on the device.

This method is called after release.

Subclasses are supposed to reimplement this method and not call the super implementation.

See Also: dispose, release

dispose back to summary

public void dispose()

Disposes of the operating system resources associated with the receiver. After this method has been invoked, the receiver will answer true when sent the message isDisposed().

See Also: release, destroy, checkDevice

dispose_Object	back to summary
pack-priv void dispose_Object(Object object)

findDevice	back to summary
pack-priv static synchronized Device findDevice(long xDisplay)

getBounds

back to summary

public Rectangle getBounds()

Returns a rectangle describing the receiver's size and location.

Returns:Rectangle

the bounding rectangle

Exceptions

SWTException:

ERROR_DEVICE_DISPOSED - if the receiver has been disposed

getBoundsInPixels	back to summary
private Rectangle getBoundsInPixels()

getClientArea back to summary

public Rectangle getClientArea()

Returns a rectangle which describes the area of the receiver which is capable of displaying data.

Returns:Rectangle

the client area

Exceptions

SWTException:

ERROR_DEVICE_DISPOSED - if the receiver has been disposed

See Also

getBounds

getDepth

back to summary

public int getDepth()

Returns the bit depth of the screen, which is the number of bits it takes to represent the number of unique colors that the screen is currently capable of displaying. This number will typically be one of 1, 8, 15, 16, 24 or 32.

Returns:int

the depth of the screen

Exceptions

SWTException:

ERROR_DEVICE_DISPOSED - if the receiver has been disposed

getDevice	back to summary
pack-priv static synchronized Device getDevice()

getDeviceData back to summary

public DeviceData getDeviceData()

Returns a DeviceData based on the receiver. Modifications made to this DeviceData will not affect the receiver.

Returns:DeviceData

a DeviceData containing the device's data and attributes

Exceptions

SWTException:

ERROR_DEVICE_DISPOSED - if the receiver has been disposed

See Also

DeviceData

getDeviceZoom

back to summary

protected int getDeviceZoom()

Gets the scaling factor from the device and calculates the zoom level.

Returns:int: zoom in percentage
Since: 3.105

getDPI

back to summary

public Point getDPI()

Returns a point whose x coordinate is the logical horizontal dots per inch of the display, and whose y coordinate is the logical vertical dots per inch of the display.

Returns:Point

the horizontal and vertical DPI

Exceptions

SWTException:

ERROR_DEVICE_DISPOSED - if the receiver has been disposed

getFontList back to summary

public FontData[] getFontList(String faceName, boolean scalable)

Returns FontData objects which describe the fonts that match the given arguments. If the faceName is null, all fonts will be returned.

Parameters

faceName:String: the name of the font to look for, or null
scalable:boolean: if true only scalable fonts are returned, otherwise only non-scalable fonts are returned.

Returns:FontData[]

the matching font data

Exceptions

SWTException:

ERROR_DEVICE_DISPOSED - if the receiver has been disposed

getScreenDPI	back to summary
pack-priv Point getScreenDPI()

getSystemColor back to summary

public Color getSystemColor(int id)

Returns the matching standard color for the given constant, which should be one of the color constants specified in class SWT. Any value other than one of the SWT color constants which is passed in will result in the color black. This color should not be freed because it was allocated by the system, not the application.

Parameters

id:int: the color constant

Returns:Color

the matching color

Exceptions

SWTException:

ERROR_DEVICE_DISPOSED - if the receiver has been disposed

See Also

SWT

getSystemFont

back to summary

public Font getSystemFont()

Returns a reasonable font for applications to use. On some platforms, this will match the "default font" or "system font" if such can be found. This font should not be freed because it was allocated by the system, not the application.

Typically, applications which want the default look should simply not set the font on the widgets they create. Widgets are always created with the correct default font for the class of user-interface component they represent.

Returns:Font

a font

Exceptions

SWTException:

ERROR_DEVICE_DISPOSED - if the receiver has been disposed

getWarnings back to summary

public boolean getWarnings()

Returns true if the underlying window system prints out warning messages on the console, and setWarnings had previously been called with true.

Returns:boolean

trueif warnings are being handled, and false otherwise

Exceptions

SWTException:

ERROR_DEVICE_DISPOSED - if the receiver has been disposed

init back to summary

protected void init()

Initializes any internal resources needed by the device.

This method is called after create.

If subclasses reimplement this method, they must call the super implementation.

See Also: create

internal_dispose_GC back to summary

public abstract void internal_dispose_GC(long hDC, GCData data)

Redeclares org.eclipse.swt.graphics.Drawable.internal_dispose_GC.

Invokes platform specific functionality to dispose a GC handle.

Important Note

This method is not part of the public API for Device. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms, and should never be called from application code.

Parameters

hDC:long: the platform specific GC handle
data:GCData: the platform specific GC data

Annotations

@Override

internal_new_GC back to summary

public abstract long internal_new_GC(GCData data)

Redeclares org.eclipse.swt.graphics.Drawable.internal_new_GC.

Invokes platform specific functionality to allocate a new GC handle.

Important Note

Parameters

data:GCData: the platform specific GC data

Returns:long

the platform specific GC handle

Annotations

@Override

isDisposed back to summary

public boolean isDisposed()

Returns true if the device has been disposed, and false otherwise.

This method gets the dispose state for the device. When a device has been disposed, it is an error to invoke any other method using the device.

Returns:boolean: true when the device is disposed and false otherwise

isTracking	back to summary
public boolean isTracking() Exceptions SWTException: ERROR_DEVICE_DISPOSED - if the receiver has been disposed Since 3.115

loadFont back to summary

public boolean loadFont(String path)

Loads the font specified by a file. The font will be present in the list of fonts available to the application.

Parameters

path:String: the font file path

Returns:boolean

whether the font was successfully loaded

Exceptions

SWTException:

ERROR_NULL_ARGUMENT - if path is null
ERROR_DEVICE_DISPOSED - if the receiver has been disposed

Since

3.3

See Also

Font

logProc	back to summary
pack-priv long logProc(long log_domain, long log_level, long message, long user_data)

new_Object	back to summary
pack-priv void new_Object(Object object)

overrideThemeValues

back to summary

private void overrideThemeValues()

For functionality & improved looks, we override some CSS theme values with custom values. Note about theme load mechanism: - This method is reached early at start of SWT initialization. Later, platform.ui will call OS.setDarkThemePreferred(true), which tells Gtk to use dark theme. This has the implication that the system theme can be 'Adwaita' (light), but later be 'darkened' by platform.ui. This means that there should not be any color-specific overrides in Adwaita theming because 'Adwaita' is used for both light and dark theme. Note about light/dark system theme: - If the System theme is Adwaita (light), eclipse can be forced to be dark with setDarkThemePreferred(true). But if the System theme is Adwaita-dark, eclipse cannot be made 'light'. Note that much of eclipse 'dark theme' is done by platform.ui's CSS engine, not by SWT.

register	back to summary
pack-priv static synchronized void register(Device device)

release back to summary

protected void release()

Releases any internal resources back to the operating system and clears all fields except the device handle.

When a device is destroyed, resources that were acquired on behalf of the programmer need to be returned to the operating system. For example, if the device allocated a font to be used as the system font, this font would be freed in release. Also,to assist the garbage collector and minimize the amount of memory that is not reclaimed when the programmer keeps a reference to a disposed device, all fields except the handle are zero'd. The handle is needed by destroy.

This method is called before destroy.

If subclasses reimplement this method, they must call the super implementation.

See Also: dispose, destroy

setTracking	back to summary
public void setTracking(boolean tracking) Exceptions SWTException: ERROR_DEVICE_DISPOSED - if the receiver has been disposed Since 3.115

setWarnings back to summary

public void setWarnings(boolean warnings)

If the underlying window system supports printing warning messages to the console, setting warnings to false prevents these messages from being printed. If the argument is true then message printing is not blocked.

Parameters

warnings:boolean: trueif warnings should be printed, and false otherwise

Exceptions

SWTException:

ERROR_DEVICE_DISPOSED - if the receiver has been disposed

startTracking	back to summary
private void startTracking()

stopTracking	back to summary
private void stopTracking()

XErrorProc	back to summary
pack-priv static long XErrorProc(long xDisplay, long xErrorEvent)

XIOErrorProc	back to summary
pack-priv static long XIOErrorProc(long xDisplay)

public abstract Class Device

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail