Package org.gnome.gtk

Class ColorDialogButton

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.gtk.ColorDialogButton

All Implemented Interfaces:

Proxy, Accessible, Buildable, ConstraintTarget

@Generated("io.github.jwharm.JavaGI")
public class ColorDialogButton
extends Widget
implements Accessible, Buildable, ConstraintTarget

Opens a color chooser dialog to select a color.

<picture> <source srcset="color-button-dark.png" media="(prefers-color-scheme: dark)"> <img alt="An example GtkColorDialogButton" src="color-button.png"> </picture>

It is suitable widget for selecting a color in a preference dialog.

CSS nodes

 colorbutton
 ╰── button.color
     ╰── [content]
 

GtkColorDialogButton has a single CSS node with name colorbutton which contains a button node. To differentiate it from a plain GtkButton, it gets the .color style class.

Since:

4.10

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ColorDialogButton.ActivateCallback	Functional interface declaration of the ActivateCallback callback.
static class	ColorDialogButton.Builder<B extends ColorDialogButton.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	ColorDialogButton.ColorDialogButtonClass

Nested classes/interfaces inherited from class org.gnome.gtk.Widget

Widget.DestroyCallback, Widget.DirectionChangedCallback, Widget.HideCallback, Widget.KeynavFailedCallback, Widget.MapCallback, Widget.MnemonicActivateCallback, Widget.MoveFocusCallback, Widget.QueryTooltipCallback, Widget.RealizeCallback, Widget.ShowCallback, Widget.StateFlagsChangedCallback, Widget.UnmapCallback, Widget.UnrealizeCallback, Widget.WidgetClass, Widget.WidgetImpl

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

InitiallyUnowned.InitiallyUnownedClass

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

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gtk.Accessible

Accessible.AccessibleImpl, Accessible.AccessibleInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Buildable

Buildable.BuildableIface, Buildable.BuildableImpl

Nested classes/interfaces inherited from interface org.gnome.gtk.ConstraintTarget

ConstraintTarget.ConstraintTargetImpl, ConstraintTarget.ConstraintTargetInterface

Field Summary

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

address

Constructor Summary

Constructors

Constructor	Description
ColorDialogButton()	Creates a new ColorDialogButton.
ColorDialogButton(MemorySegment address)	Create a ColorDialogButton proxy instance for the provided memory address.
ColorDialogButton(@Nullable ColorDialog dialog)	Creates a new GtkColorDialogButton with the given GtkColorDialog.

Method Summary

Modifier and Type	Method	Description
protected ColorDialogButton	asParent()	Returns this instance as if it were its parent type.
static ColorDialogButton.Builder<? extends ColorDialogButton.Builder>	builder()	A ColorDialogButton.Builder object constructs a ColorDialogButton with the specified properties.
void	emitActivate()	Emits the "activate" signal.
ColorDialog	getDialog()	Returns the GtkColorDialog of this ColorDialogButton.
RGBA	getRgba()	Returns the color of the button.
static Type	getType()	Get the GType of the ColorDialogButton class
SignalConnection<ColorDialogButton.ActivateCallback>	onActivate(ColorDialogButton.ActivateCallback handler)	Emitted when the color dialog button is activated.
void	setDialog(ColorDialog dialog)	Sets a GtkColorDialog object to use for creating the color chooser dialog that is presented when the user clicks the button.
void	setRgba(RGBA color)	Sets the color of the button.

Methods inherited from class org.gnome.gtk.Widget

actionSetEnabled, activateActionIfExists, activateDefault, activateWidget, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, cssChanged, directionChanged, disposeTemplate, dragCheckThreshold, emitDestroy, emitDirectionChanged, emitHide, emitKeynavFailed, emitMap, emitMnemonicActivate, emitMoveFocus, emitQueryTooltip, emitRealize, emitShow, emitStateFlagsChanged, emitUnmap, emitUnrealize, errorBell, focus, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBaseline, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getDefaultDirection, getDirection, getDisplay, getFirstChild, getFocusable, getFocusChild, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getLimitEvents, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMemoryLayout, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, moveFocus, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, pick, queryTooltip, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, root, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setLimitEvents, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, sizeAllocate, snapshot, snapshotChild, stateFlagsChanged, systemSettingChanged, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unroot, unsetStateFlags, unsetStateFlags

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

Methods inherited from interface org.gnome.gtk.Accessible

announce, getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getFirstAccessibleChild, getNextAccessibleSibling, getPlatformState, resetProperty, resetRelation, resetState, setAccessibleParent, updateNextAccessibleSibling, updatePlatformState, updateProperty, updateRelation, updateState

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Constructor Details

ColorDialogButton

public ColorDialogButton(MemorySegment address)

Create a ColorDialogButton proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

ColorDialogButton

public ColorDialogButton(@Nullable
 @Nullable ColorDialog dialog)

Creates a new GtkColorDialogButton with the given GtkColorDialog.

You can pass NULL to this function and set a GtkColorDialog later. The button will be insensitive until that happens.

Parameters:

dialog - the GtkColorDialog to use

Since:

4.10

ColorDialogButton

public ColorDialogButton()

Creates a new ColorDialogButton.

Method Details

getType

public static Type getType()

Get the GType of the ColorDialogButton class

Returns:

the GType

asParent

protected ColorDialogButton asParent()

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 Widget

getDialog

public ColorDialog getDialog()

Returns the GtkColorDialog of this ColorDialogButton.

Returns:

the GtkColorDialog

Since:

4.10

getRgba

public RGBA getRgba()

Returns the color of the button.

This function is what should be used to obtain the color that was chosen by the user. To get informed about changes, listen to "notify::rgba".

Returns:

the color

Since:

4.10

setDialog

public void setDialog(ColorDialog dialog)

Sets a GtkColorDialog object to use for creating the color chooser dialog that is presented when the user clicks the button.

Parameters:

dialog - the new GtkColorDialog

Since:

4.10

setRgba

public void setRgba(RGBA color)

Sets the color of the button.

Parameters:

color - the new color

Since:

4.10

onActivate

public SignalConnection<ColorDialogButton.ActivateCallback> onActivate(ColorDialogButton.ActivateCallback handler)

Emitted when the color dialog button is activated.

The ::activate signal on GtkColorDialogButton is an action signal and emitting it causes the button to pop up its dialog.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

4.14

See Also:

• ColorDialogButton.ActivateCallback.run()

emitActivate

public void emitActivate()

Emits the "activate" signal. See onActivate(org.gnome.gtk.ColorDialogButton.ActivateCallback).

builder

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

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