Package org.gnome.gtk

Class StyleContext

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.StyleContext

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
@Deprecated
public class StyleContext
extends GObject

Deprecated.

GtkStyleContext stores styling information affecting a widget.

In order to construct the final style information, GtkStyleContext queries information from all attached GtkStyleProviders. Style providers can be either attached explicitly to the context through addProvider(org.gnome.gtk.StyleProvider, int), or to the display through addProviderForDisplay(org.gnome.gdk.Display, org.gnome.gtk.StyleProvider, int). The resulting style is a combination of all providers’ information in priority order.

For GTK widgets, any GtkStyleContext returned by Widget.getStyleContext() will already have a GdkDisplay and RTL/LTR information set. The style context will also be updated automatically if any of these settings change on the widget.

Style Classes
Widgets can add style classes to their context, which can be used to associate different styles by class. The documentation for individual widgets lists which style classes it uses itself, and which style classes may be added by applications to affect their appearance.

Custom styling in UI libraries and applications
If you are developing a library with custom widgets that render differently than standard components, you may need to add a GtkStyleProvider yourself with the GTK_STYLE_PROVIDER_PRIORITY_FALLBACK priority, either a GtkCssProvider or a custom object implementing the GtkStyleProvider interface. This way themes may still attempt to style your UI elements in a different way if needed so.

If you are using custom styling on an applications, you probably want then to make your style information prevail to the theme’s, so you must use a GtkStyleProvider with the GTK_STYLE_PROVIDER_PRIORITY_APPLICATION priority, keep in mind that the user settings in XDG_CONFIG_HOME/gtk-4.0/gtk.css will still take precedence over your changes, as it uses the GTK_STYLE_PROVIDER_PRIORITY_USER priority.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StyleContext.Builder<B extends StyleContext.Builder<B>>	Deprecated. Inner class implementing a builder pattern to construct a GObject with properties.
static class	StyleContext.StyleContextClass	Deprecated.

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
StyleContext(MemorySegment address)	Deprecated. Create a StyleContext proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	addClass(String className)	Deprecated. Use Widget.addCssClass(java.lang.String) instead
void	addProvider(StyleProvider provider, int priority)	Deprecated. Use style classes instead
static void	addProviderForDisplay(Display display, StyleProvider provider, int priority)	Deprecated.
protected StyleContext	asParent()	Deprecated. Returns this instance as if it were its parent type.
static StyleContext.Builder<? extends StyleContext.Builder>	builder()	Deprecated. A StyleContext.Builder object constructs a StyleContext with the specified properties.
protected void	changed()	Deprecated.
void	getBorder(Border border)	Deprecated. This api will be removed in GTK 5
void	getColor(RGBA color)	Deprecated. Use Widget.getColor(org.gnome.gdk.RGBA) instead
Display	getDisplay()	Deprecated. Use Widget.getDisplay() instead
void	getMargin(Border margin)	Deprecated. This api will be removed in GTK 5
static MemoryLayout	getMemoryLayout()	Deprecated. The memory layout of the native struct.
void	getPadding(Border padding)	Deprecated. This api will be removed in GTK 5
int	getScale()	Deprecated. Use Widget.getScaleFactor() instead
Set<StateFlags>	getState()	Deprecated. Use Widget.getStateFlags() instead
static Type	getType()	Deprecated. Get the GType of the StyleContext class
boolean	hasClass(String className)	Deprecated. Use Widget.hasCssClass(java.lang.String) instead
boolean	lookupColor(String colorName, RGBA color)	Deprecated. This api will be removed in GTK 5
void	removeClass(String className)	Deprecated. Use Widget.removeCssClass(java.lang.String) instead
void	removeProvider(StyleProvider provider)	Deprecated.
static void	removeProviderForDisplay(Display display, StyleProvider provider)	Deprecated.
void	restore()	Deprecated. This API will be removed in GTK 5
void	save()	Deprecated. This API will be removed in GTK 5
void	setDisplay(Display display)	Deprecated. You should not use this api
void	setScale(int scale)	Deprecated. You should not use this api
void	setState(Set<StateFlags> flags)	Deprecated. You should not use this api
void	setState(StateFlags... flags)	Deprecated. You should not use this api
String	toString(Set<StyleContextPrintFlags> flags)	Deprecated. This api will be removed in GTK 5
String	toString(StyleContextPrintFlags... flags)	Deprecated. This api will be removed in GTK 5

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StyleContext

public StyleContext(MemorySegment address)

Deprecated.

Create a StyleContext proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Deprecated.

Get the GType of the StyleContext class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

Deprecated.

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected StyleContext asParent()

Deprecated.

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

addProviderForDisplay

@Deprecated
public static void addProviderForDisplay(Display display,
 StyleProvider provider,
 int priority)

Deprecated.

Adds a global style provider to display, which will be used in style construction for all GtkStyleContexts under display.

GTK uses this to make styling information from GtkSettings available.

Note: If both priorities are the same, A GtkStyleProvider added through addProvider(org.gnome.gtk.StyleProvider, int) takes precedence over another added through this function.

Parameters:

display - a GdkDisplay

provider - a GtkStyleProvider

priority - the priority of the style provider. The lower it is, the earlier it will be used in the style construction. Typically this will be in the range between GTK_STYLE_PROVIDER_PRIORITY_FALLBACK and GTK_STYLE_PROVIDER_PRIORITY_USER

removeProviderForDisplay

@Deprecated
public static void removeProviderForDisplay(Display display,
 StyleProvider provider)

Deprecated.

Removes provider from the global style providers list in display.

Parameters:

display - a GdkDisplay

provider - a GtkStyleProvider

addClass

@Deprecated
public void addClass(String className)

Deprecated.

Use Widget.addCssClass(java.lang.String) instead

Adds a style class to this StyleContext, so later uses of the style context will make use of this new class for styling.

In the CSS file format, a GtkEntry defining a “search” class, would be matched by:

entry.search { ... }
 

While any widget defining a “search” class would be matched by:

.search { ... }
 

Parameters:

className - class name to use in styling

addProvider

@Deprecated
public void addProvider(StyleProvider provider,
 int priority)

Deprecated.

Use style classes instead

Adds a style provider to this StyleContext, to be used in style construction.

Note that a style provider added by this function only affects the style of the widget to which this StyleContext belongs. If you want to affect the style of all widgets, use addProviderForDisplay(org.gnome.gdk.Display, org.gnome.gtk.StyleProvider, int).

Note: If both priorities are the same, a GtkStyleProvider added through this function takes precedence over another added through addProviderForDisplay(org.gnome.gdk.Display, org.gnome.gtk.StyleProvider, int).

Parameters:

provider - a GtkStyleProvider

priority - the priority of the style provider. The lower it is, the earlier it will be used in the style construction. Typically this will be in the range between GTK_STYLE_PROVIDER_PRIORITY_FALLBACK and GTK_STYLE_PROVIDER_PRIORITY_USER

getBorder

@Deprecated
public void getBorder(Border border)

Deprecated.

This api will be removed in GTK 5

Gets the border for a given state as a GtkBorder.

Parameters:

border - return value for the border settings

getColor

@Deprecated
public void getColor(RGBA color)

Deprecated.

Use Widget.getColor(org.gnome.gdk.RGBA) instead

Gets the foreground color for a given state.

Parameters:

color - return value for the foreground color

getDisplay

@Deprecated
public Display getDisplay()

Deprecated.

Use Widget.getDisplay() instead

Returns the GdkDisplay to which this StyleContext is attached.

Returns:

a GdkDisplay.

getMargin

@Deprecated
public void getMargin(Border margin)

Deprecated.

This api will be removed in GTK 5

Gets the margin for a given state as a GtkBorder.

Parameters:

margin - return value for the margin settings

getPadding

@Deprecated
public void getPadding(Border padding)

Deprecated.

This api will be removed in GTK 5

Gets the padding for a given state as a GtkBorder.

Parameters:

padding - return value for the padding settings

getScale

@Deprecated
public int getScale()

Deprecated.

Use Widget.getScaleFactor() instead

Returns the scale used for assets.

Returns:

the scale

getState

@Deprecated
public Set<StateFlags> getState()

Deprecated.

Use Widget.getStateFlags() instead

Returns the state used for style matching.

This method should only be used to retrieve the GtkStateFlags to pass to GtkStyleContext methods, like getPadding(org.gnome.gtk.Border). If you need to retrieve the current state of a GtkWidget, use Widget.getStateFlags().

Returns:

the state flags

hasClass

@Deprecated
public boolean hasClass(String className)

Deprecated.

Use Widget.hasCssClass(java.lang.String) instead

Returns true if this StyleContext currently has defined the given class name.

Parameters:

className - a class name

Returns:

true if this StyleContext has className defined

lookupColor

@Deprecated
public boolean lookupColor(String colorName,
 RGBA color)

Deprecated.

This api will be removed in GTK 5

Looks up and resolves a color name in the this StyleContext color map.

Parameters:

colorName - color name to lookup

color - Return location for the looked up color

Returns:

true if colorName was found and resolved, false otherwise

removeClass

@Deprecated
public void removeClass(String className)

Deprecated.

Use Widget.removeCssClass(java.lang.String) instead

Removes className from this StyleContext.

Parameters:

className - class name to remove

removeProvider

@Deprecated
public void removeProvider(StyleProvider provider)

Deprecated.

Removes provider from the style providers list in this StyleContext.

Parameters:

provider - a GtkStyleProvider

restore

@Deprecated
public void restore()

Deprecated.

This API will be removed in GTK 5

Restores this StyleContext state to a previous stage.

See save().

save

@Deprecated
public void save()

Deprecated.

This API will be removed in GTK 5

Saves the this StyleContext state.

This allows temporary modifications done through addClass(java.lang.String), removeClass(java.lang.String), setState(java.util.Set<org.gnome.gtk.StateFlags>) to be quickly reverted in one go through restore().

The matching call to restore() must be done before GTK returns to the main loop.

setDisplay

@Deprecated
public void setDisplay(Display display)

Deprecated.

You should not use this api

Attaches this StyleContext to the given display.

The display is used to add style information from “global” style providers, such as the display's GtkSettings instance.

If you are using a GtkStyleContext returned from Widget.getStyleContext(), you do not need to call this yourself.

Parameters:

display - a GdkDisplay

setScale

@Deprecated
public void setScale(int scale)

Deprecated.

You should not use this api

Sets the scale to use when getting image assets for the style.

Parameters:

scale - scale

setState

@Deprecated
public void setState(Set<StateFlags> flags)

Deprecated.

You should not use this api

Sets the state to be used for style matching.

Parameters:

flags - state to represent

setState

@Deprecated
public void setState(StateFlags... flags)

Deprecated.

You should not use this api

Sets the state to be used for style matching.

Parameters:

flags - state to represent

toString

@Deprecated
public String toString(Set<StyleContextPrintFlags> flags)

Deprecated.

This api will be removed in GTK 5

Converts the style context into a string representation.

The string representation always includes information about the name, state, id, visibility and style classes of the CSS node that is backing this StyleContext. Depending on the flags, more information may be included.

This function is intended for testing and debugging of the CSS implementation in GTK. There are no guarantees about the format of the returned string, it may change.

Parameters:

flags - Flags that determine what to print

Returns:

a newly allocated string representing this StyleContext

toString

@Deprecated
public String toString(StyleContextPrintFlags... flags)

Deprecated.

This api will be removed in GTK 5

Converts the style context into a string representation.

The string representation always includes information about the name, state, id, visibility and style classes of the CSS node that is backing this StyleContext. Depending on the flags, more information may be included.

This function is intended for testing and debugging of the CSS implementation in GTK. There are no guarantees about the format of the returned string, it may change.

Parameters:

flags - Flags that determine what to print

Returns:

a newly allocated string representing this StyleContext

changed

protected void changed()

Deprecated.

builder

public static StyleContext.Builder<? extends StyleContext.Builder> builder()

Deprecated.

A StyleContext.Builder object constructs a StyleContext with the specified properties. Use the various set...() methods to set properties, and finish construction with StyleContext.Builder.build().