Package org.gnome.gtk

Class ColorDialog

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.ColorDialog

All Implemented Interfaces:

Proxy

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

Asynchronous API to present a color chooser dialog.

GtkColorDialog collects the arguments that are needed to present the dialog to the user, such as a title for the dialog and whether it should be modal.

The dialog is shown with the chooseRgba(org.gnome.gtk.Window, org.gnome.gdk.RGBA, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) function.

See ColorDialogButton for a convenient control that uses GtkColorDialog and presents the results.

Since:

4.10

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
ColorDialog()	Creates a new ColorDialog.
ColorDialog(MemorySegment address)	Create a ColorDialog proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected ColorDialog	asParent()	Returns this instance as if it were its parent type.
static ColorDialog.Builder<? extends ColorDialog.Builder>	builder()	A ColorDialog.Builder object constructs a ColorDialog with the specified properties.
void	chooseRgba(@Nullable Window parent, @Nullable RGBA initialColor, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Presents a color chooser dialog to the user.
RGBA	chooseRgbaFinish(AsyncResult result)	Finishes the chooseRgba(org.gnome.gtk.Window, org.gnome.gdk.RGBA, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call
boolean	getModal()	Returns whether the color chooser dialog blocks interaction with the parent window while it is presented.
String	getTitle()	Returns the title that will be shown on the color chooser dialog.
static @Nullable Type	getType()	Get the GType of the ColorDialog class
boolean	getWithAlpha()	Returns whether colors may have alpha.
void	setModal(boolean modal)	Sets whether the color chooser dialog blocks interaction with the parent window while it is presented.
void	setTitle(String title)	Sets the title that will be shown on the color chooser dialog.
void	setWithAlpha(boolean withAlpha)	Sets whether colors may have alpha.

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, getMemoryLayout, 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, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

ColorDialog

public ColorDialog(MemorySegment address)

Create a ColorDialog proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

ColorDialog

public ColorDialog()

Creates a new ColorDialog.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the ColorDialog class

Returns:

the GType

asParent

protected ColorDialog 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 GObject

chooseRgba

public void chooseRgba(@Nullable Window parent,
 @Nullable RGBA initialColor,
 @Nullable Cancellable cancellable,
 @Nullable AsyncReadyCallback callback)

Presents a color chooser dialog to the user.

Parameters:

parent - the parent window

initialColor - the color to select initially

cancellable - a cancellable to cancel the operation

callback - a callback to call when the operation is complete

Since:

4.10

chooseRgbaFinish

public RGBA chooseRgbaFinish(AsyncResult result)
                      throws GErrorException

Finishes the chooseRgba(org.gnome.gtk.Window, org.gnome.gdk.RGBA, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call

Note that this function returns a Gtk.DialogError.DISMISSED error if the user cancels the dialog.

Parameters:

result - the result

Returns:

the selected color

Throws:

GErrorException - see GError

Since:

4.10

getModal

public boolean getModal()

Returns whether the color chooser dialog blocks interaction with the parent window while it is presented.

Returns:

true if the color chooser dialog is modal

Since:

4.10

getTitle

public String getTitle()

Returns the title that will be shown on the color chooser dialog.

Returns:

the title

Since:

4.10

getWithAlpha

public boolean getWithAlpha()

Returns whether colors may have alpha.

Returns:

true if colors may have alpha

Since:

4.10

setModal

public void setModal(boolean modal)

Sets whether the color chooser dialog blocks interaction with the parent window while it is presented.

Parameters:

modal - the new value

Since:

4.10

setTitle

public void setTitle(String title)

Sets the title that will be shown on the color chooser dialog.

Parameters:

title - the new title

Since:

4.10

setWithAlpha

public void setWithAlpha(boolean withAlpha)

Sets whether colors may have alpha.

Parameters:

withAlpha - the new value

Since:

4.10

builder

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

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

Returns:

the builder object